Struct ruma_client_api::room::get_summary::msc3266::Response
source · #[non_exhaustive]pub struct Response {Show 13 fields
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>,
}
Expand description
Response type for the get_summary
endpoint.
Fields (Non-exhaustive)§
This struct is marked as 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.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§
Trait Implementations§
source§impl IncomingResponse for Response
impl IncomingResponse for Response
§type EndpointError = Error
type EndpointError = Error
A type capturing the expected error conditions the server can return.
source§fn try_from_http_response<T: AsRef<[u8]>>(
response: Response<T>,
) -> Result<Self, FromHttpResponseError<Error>>
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.Auto Trait Implementations§
impl Freeze for Response
impl RefUnwindSafe for Response
impl Send for Response
impl Sync for Response
impl Unpin for Response
impl UnwindSafe for Response
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)