Struct Request 

#[non_exhaustive]
pub struct Request {
    pub from: UInt,
    pub limit: Option<UInt>,
    pub user_id: Option<OwnedUserId>,
    pub name: Option<String>,
    pub guests: bool,
    pub deactivated: bool,
    pub locked: bool,
}

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.

from: UInt

Offset in the returned list.

Defaults to 0.

limit: Option<UInt>

Maximum amount of users to return. Defaults to 100.

user_id: Option<OwnedUserId>

user_id is optional and filters to only return users with user IDs that contain this value.

This parameter is ignored when using the name parameter.

name: Option<String>

name is optional and filters to only return users with user ID localparts or displaynames that contain this value.

guests: bool

The parameter guests is optional and if false will exclude guest users.

Defaults to true to include guest users.

deactivated: bool

The parameter deactivated is optional and if true will include deactivated users.

Defaults to false to exclude deactivated users.

locked: bool

Whether to include locked users in the response.

Defaults to false to exclude locked users.

Implementations

impl Request

pub fn new() -> Self

Creates an empty Request.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl Default for Request

fn default() -> Request

Returns the “default value” for a type.

impl Metadata for Request

const METHOD: Method = ::ruma_common::exports::http::Method::GET

The HTTP method used by this endpoint.

const RATE_LIMITED: bool = false

Whether or not this endpoint is rate limited by the server.

const PATH_BUILDER: SinglePath

All info pertaining to an endpoint’s path.

type Authentication = AccessToken

What authentication scheme the server uses for this endpoint.

type PathBuilder = SinglePath

The type used to build an endpoint’s path.

fn empty_request_body<B>() -> B

where B: Default + BufMut,

Returns an empty request body for this Matrix request.

fn make_endpoint_url( path_builder_input: <Self::PathBuilder as PathBuilder>::Input<'_>, base_url: &str, path_args: &[&dyn Display], query_string: &str, ) -> Result<String, IntoHttpError>

Generate the endpoint URL for this endpoint.