Struct ruma_client_api::push::get_notifications::v3::Request

#[non_exhaustive]
pub struct Request<'a> {
    pub from: Option<&'a str>,
    pub limit: Option<UInt>,
    pub only: Option<&'a str>,
}

Data for a request to the get_notifications API endpoint.

Paginate through the list of events that the user has been, or would have been notified about.

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

Pagination token given to retrieve the next set of events.

limit: Option<UInt>

Limit on the number of events to return in this request.

only: Option<&'a str>

Allows basic filtering of events returned.

Supply “highlight” to return only events where the notification had the ‘highlight’ tweak set.

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

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