Struct synapse_admin_api::users::list_users::v2::Request

#[non_exhaustive]
pub struct Request<'a> {
    pub from: UInt,
    pub limit: Option<UInt>,
    pub user_id: Option<&'a UserId>,
    pub name: Option<&'a str>,
    pub guests: bool,
    pub deactivated: bool,
}

Data for a request to the list_users API endpoint.

list users endpoint

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<&'a UserId>

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<&'a str>

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.

Implementations

impl<'a> Request<'a>

pub fn new() -> Self

Creates an empty Request.

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> Default for Request<'a>

fn default() -> Request<'a>

Returns the “default value” for a type.

impl<'a> Outgoing for Request<'a>

type Incoming = IncomingRequest

The ‘Incoming’ variant of Self.