Struct ruma::api::client::user_directory::search_users::v3::Request

pub struct Request<'a> {
    pub search_term: &'a str,
    pub limit: UInt,
    pub language: Option<String>,
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

Data for a request to the search_users API endpoint.

Performs a search for users.

Fields

search_term: &'a str

The term to search for.

limit: UInt

The maximum number of results to return.

Defaults to 10.

language: Option<String>

Language tag to determine the collation to use for the (case-insensitive) search.

See MDN for the syntax.

Implementations

impl<'a> Request<'a>

pub fn new(search_term: &'a str) -> Request<'a>

Creates a new Request with the given search term.

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<(), Error>

Formats the value using the given formatter.

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

Available on crate feature client only.

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>(
    self,
    base_url: &str,
    access_token: SendAccessToken<'_>,
    considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>where
    T: Default + BufMut,

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