Struct synapse_admin_api::users::list_users::v2::Response

#[non_exhaustive]
pub struct Response {
    pub users: Vec<UserMinorDetails>,
    pub next_token: Option<String>,
    pub total: UInt,
}

Data in the response from the list_users API 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.

users: Vec<UserMinorDetails>

List of users containing UserMinorDetails.

next_token: Option<String>

Token to receive the next UserMinorDetails batch.

To paginate, check for next_token and if present, call the endpoint again with from set to the value of next_token. This will return a new page. If the endpoint does not return a next_token then there are no more users to paginate through.

total: UInt

Total amount of users.

Implementations

impl Response

pub fn new(users: Vec<UserMinorDetails>, total: UInt) -> Self

Creates a Response with the given UserMinorDetails and the total amount of users.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Response

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

Formats the value using the given formatter.

impl Outgoing for Response

type Incoming = Self

The ‘Incoming’ variant of Self.