Struct ruma_client_api::membership::get_member_events::v3::Request

#[non_exhaustive]
pub struct Request<'a> {
    pub room_id: &'a RoomId,
    pub at: Option<&'a str>,
    pub membership: Option<MembershipEventFilter>,
    pub not_membership: Option<MembershipEventFilter>,
}

Data for a request to the get_member_events API endpoint.

Get membership events for a room.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

room_id: &'a RoomId

The room to get the member events for.

at: Option<&'a str>

The point in time (pagination token) to return members for in the room.

This token can be obtained from a prev_batch token returned for each room by the sync API.

membership: Option<MembershipEventFilter>

The kind of memberships to filter for.

Defaults to no filtering if unspecified. When specified alongside not_membership, the two parameters create an ‘or’ condition: either the membership is the same as membership or is not the same as not_membership.

not_membership: Option<MembershipEventFilter>

The kind of memberships to exclude from the results.

Defaults to no filtering if unspecified.

Implementations

impl<'a> Request<'a>

pub fn new(room_id: &'a RoomId) -> Self

Creates a new Request with the given room ID.

Trait Implementations

impl<'a> Clone for Request<'a>

fn clone(&self) -> Request<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> OutgoingRequest for Request<'a>

type EndpointError = Error

A type capturing the expected error conditions the server can return.

type IncomingResponse = Response

Response type returned when the request is successful.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

fn try_into_http_request<T: Default + BufMut>(
    self,
    base_url: &str,
    access_token: SendAccessToken<'_>,
    considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>

Tries to convert this request into an http::Request.