Struct ruma::api::client::r0::directory::PublicRoomsChunk [−][src]
pub struct PublicRoomsChunk {
pub aliases: Vec<RoomAliasId, Global>,
pub canonical_alias: Option<RoomAliasId>,
pub name: Option<Box<RoomName, Global>>,
pub num_joined_members: UInt,
pub room_id: RoomId,
pub topic: Option<String>,
pub world_readable: bool,
pub guest_can_join: bool,
pub avatar_url: Option<MxcUri>,
pub join_rule: Option<JoinRule>,
}
api
and (crate features client-api
or client-api-c
or client-api-s
) only.Expand description
A chunk of a room list response, describing one room
Fields
aliases: Vec<RoomAliasId, Global>
Aliases of the room.
canonical_alias: Option<RoomAliasId>
The canonical alias of the room, if any.
name: Option<Box<RoomName, Global>>
The name of the room, if any.
num_joined_members: UInt
The number of members joined to the room.
room_id: RoomId
The ID of the room.
topic: Option<String>
The topic of the room, if any.
world_readable: bool
Whether the room may be viewed by guest users without joining.
guest_can_join: bool
Whether guest users may join the room and participate in it.
If they can, they will be subject to ordinary power level rules like any other user.
avatar_url: Option<MxcUri>
The URL for the room’s avatar, if one is set.
If you activate the compat
feature, this field being an empty string in JSON will give
you None
here.
join_rule: Option<JoinRule>
The joining rule for the room.
Implementations
Creates a new PublicRoomsChunk
with the given room ID.
All other fields will be propagated with default values (an empty list of aliases, None
for all Option
al fields and false
for all boolean fields), which should be overridden;
the assign!
macro from the assign
crate can simplify this.
Trait Implementations
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<PublicRoomsChunk, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<PublicRoomsChunk, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
pub fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
pub fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
Serialize this value into the given Serde serializer. Read more
Auto Trait Implementations
impl RefUnwindSafe for PublicRoomsChunk
impl Send for PublicRoomsChunk
impl Sync for PublicRoomsChunk
impl Unpin for PublicRoomsChunk
impl UnwindSafe for PublicRoomsChunk
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
type Output = T
type Output = T
Should always be Self
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more