Struct matrix_sdk::ruma::api::client::search::search_events::v3::Request

#[non_exhaustive]
pub struct Request {
    pub next_batch: Option<String>,
    pub search_categories: Categories,
}

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

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

next_batch: Option<String>

The point to return events from.

If given, this should be a next_batch result from a previous call to this endpoint.

search_categories: Categories

Describes which categories to search in and their criteria.

Implementations

impl Request

pub fn new(search_categories: Categories) -> Request

Creates a new Request with the given categories.

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

Formats the value using the given formatter.

impl OutgoingRequest for Request

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