Struct ruma_client_api::relations::get_relating_events::v1::Request
source · #[non_exhaustive]pub struct Request {
pub room_id: OwnedRoomId,
pub event_id: OwnedEventId,
pub from: Option<String>,
pub dir: Direction,
pub to: Option<String>,
pub limit: Option<UInt>,
pub recurse: bool,
}
Expand description
Request type for the get_relating_events
endpoint.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.room_id: OwnedRoomId
The ID of the room containing the parent event.
event_id: OwnedEventId
The ID of the parent event whose child events are to be returned.
from: Option<String>
The pagination token to start returning results from.
If None
, results start at the most recent topological event known to the server.
Can be a next_batch
or prev_batch
token from a previous call, or a returned
start
token from /messages
or a next_batch
token from /sync
.
Note that when paginating the from
token should be “after” the to
token in
terms of topological ordering, because it is only possible to paginate “backwards”
through events, starting at from
.
dir: Direction
The direction to return events from.
Defaults to Direction::Backward
.
to: Option<String>
The pagination token to stop returning results at.
If None
, results continue up to limit
or until there are no more events.
Like from
, this can be a previous token from a prior call to this endpoint
or from /messages
or /sync
.
limit: Option<UInt>
The maximum number of results to return in a single chunk
.
The server can and should apply a maximum value to this parameter to avoid large responses.
Similarly, the server should apply a default value when not supplied.
recurse: bool
Whether to include events which relate indirectly to the given event.
These are events related to the given event via two or more direct relationships.
It is recommended that homeservers traverse at least 3 levels of relationships. Implementations may perform more but should be careful to not infinitely recurse.
Default to false
.
Implementations§
source§impl Request
impl Request
sourcepub fn new(room_id: OwnedRoomId, event_id: OwnedEventId) -> Self
pub fn new(room_id: OwnedRoomId, event_id: OwnedEventId) -> Self
Creates a new Request
with the given room ID and parent event ID.
Trait Implementations§
source§impl OutgoingRequest for Request
impl OutgoingRequest for Request
§type EndpointError = Error
type EndpointError = Error
§type IncomingResponse = Response
type IncomingResponse = Response
source§fn try_into_http_request<T: Default + BufMut>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
considering_versions: &[MatrixVersion],
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request<T: Default + BufMut>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>
http::Request
. Read moreAuto Trait Implementations§
impl Freeze for Request
impl RefUnwindSafe for Request
impl Send for Request
impl Sync for Request
impl Unpin for Request
impl UnwindSafe for Request
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
source§fn try_into_http_request_with_user_id<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
user_id: &UserId,
considering_versions: &[MatrixVersion],
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request_with_user_id<T>( self, base_url: &str, access_token: SendAccessToken<'_>, user_id: &UserId, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>
http::Request
and appends a virtual user_id
to
assert Appservice identity.