Struct synapse_admin_api::rooms::list_rooms::v1::Response

#[non_exhaustive]
pub struct Response {
    pub rooms: Vec<RoomDetails>,
    pub offset: UInt,
    pub total_rooms: UInt,
    pub next_batch: Option<UInt>,
    pub prev_batch: Option<UInt>,
}

Data in the response from the list_rooms_v1 API 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.

rooms: Vec<RoomDetails>

List all RoomDetails.

offset: UInt

Offset.

total_rooms: UInt

Total amount of rooms.

next_batch: Option<UInt>

Token to receive the next RoomDetails batch.

prev_batch: Option<UInt>

Token to receive the previous RoomDetails batch.

Implementations

impl Response

pub fn new() -> Self

Creates an empty Response.

Trait Implementations

impl Clone for Response

fn clone(&self) -> Response

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Response

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Response

fn default() -> Response

Returns the “default value” for a type.

impl Outgoing for Response

type Incoming = Self

The ‘Incoming’ variant of Self.