Struct ruma::api::client::room::get_summary::msc3266::Response

source ·
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>,
}
Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api and crate feature unstable-msc3266 only.
Expand description

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§

source§

impl Response

source

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

Creates a new Response with all the mandatory fields set.

Trait Implementations§

source§

impl Clone for Response

source§

fn clone(&self) -> Response

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Response

source§

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

Formats the value using the given formatter. Read more
source§

impl IncomingResponse for Response

Available on crate feature client only.
source§

type EndpointError = Error

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

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

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

impl OutgoingResponse for Response

Available on crate feature server only.
source§

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

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

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

source§

const WITNESS: W = W::MAKE

A constant of the type witness
source§

impl<T> Identity for T
where T: ?Sized,

source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> ErasedDestructor for T
where T: 'static,

source§

impl<T> MaybeSendSync for T