Struct ruma_client_api::room::get_summary::msc3266::Response

pub struct Response {

    pub room_id: OwnedRoomId,
    pub canonical_alias: Option<OwnedRoomAliasId>,
    pub avatar_url: Option<OwnedMxcUri>,
    pub guest_can_join: bool,
    pub name: Option<String>,
    pub num_joined_members: UInt,
    pub topic: Option<String>,
    pub world_readable: bool,
    pub join_rule: SpaceRoomJoinRule,
    pub room_type: Option<RoomType>,
    pub room_version: Option<RoomVersionId>,
    pub membership: Option<MembershipState>,
    pub encryption: Option<EventEncryptionAlgorithm>,
}

Available on (crate features client or server) and crate feature unstable-msc3266 only.

Response type for the get_summary endpoint.

Fields

room_id: OwnedRoomId

ID of the room (useful if it’s an alias).

canonical_alias: Option<OwnedRoomAliasId>

The canonical alias for this room, if set.

avatar_url: Option<OwnedMxcUri>

Avatar of the room.

guest_can_join: bool

Whether guests can join the room.

name: Option<String>

Name of the room.

num_joined_members: UInt

Member count of the room.

topic: Option<String>

Topic of the room.

world_readable: bool

Whether the room history can be read without joining.

join_rule: SpaceRoomJoinRule

Join rule of the room.

room_type: Option<RoomType>

Type of the room, if any.

room_version: Option<RoomVersionId>

Version of the room.

membership: Option<MembershipState>

The current membership of this user in the room.

This field will not be present when called unauthenticated, but is required when called authenticated. It should be leave if the server doesn’t know about the room, since for all other membership states the server would know about the room already.

encryption: Option<EventEncryptionAlgorithm>

If the room is encrypted, the algorithm used for this room.

Implementations

impl Response

pub fn new( room_id: OwnedRoomId, join_rule: SpaceRoomJoinRule, guest_can_join: bool, num_joined_members: UInt, world_readable: bool, ) -> Self

Creates a new Response with all the mandatory fields set.

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 IncomingResponse for Response

Available on crate feature client only.

type EndpointError = Error

A type capturing the expected error conditions the server can return.

fn try_from_http_response<T: AsRef<[u8]>>( response: Response<T>, ) -> Result<Self, FromHttpResponseError<Error>>

Tries to convert the given http::Response into this response type.

impl OutgoingResponse for Response

Available on crate feature server only.

fn try_into_http_response<T: Default + BufMut>( self, ) -> Result<Response<T>, IntoHttpError>

Tries to convert this response into an http::Response.