Struct ruma_client_api::user_directory::search_users::v3::Request

#[non_exhaustive]
pub struct Request {
    pub search_term: String,
    pub limit: UInt,
    pub language: Option<String>,
}

Request type for the search_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.

search_term: String

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 Request

pub fn new(search_term: String) -> Self

Creates a new Request with the given search term.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy 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 OutgoingRequest for Request

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 = 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.