Struct synapse_admin_api::rooms::list_rooms::v1::Request

#[non_exhaustive]
pub struct Request {
    pub from: Option<UInt>,
    pub limit: Option<UInt>,
    pub order_by: Option<RoomSortOrder>,
    pub dir: Option<SortDirection>,
    pub search_term: Option<String>,
}

Data for a request to the list_rooms_v1 API endpoint.

list rooms 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.

from: Option<UInt>

Offset in the returned list. Defaults to 0.

limit: Option<UInt>

Maximum amount of rooms to return. Defaults to 100.

order_by: Option<RoomSortOrder>

Sort order of the response.

dir: Option<SortDirection>

Sort direction of the response.

search_term: Option<String>

Filter rooms by their room name. Search term can be contained in any part of the room name. Defaults to no filtering.

Implementations

impl Request

pub fn new() -> Self

Creates an empty Request.

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 Default for Request

fn default() -> Request

Returns the “default value” for a type.

impl Outgoing for Request

type Incoming = Self

The ‘Incoming’ variant of Self.