Struct matrix_sdk_base::RoomInfo

source · [−]

pub struct RoomInfo { /* private fields */ }

Expand description

The underlying pure data structure for joined and left rooms.

Holds all the info needed to persist a room into the state store.

Implementations

source

impl RoomInfo

source

pub fn mark_as_joined(&mut self)

Mark this Room as joined

source

pub fn mark_as_left(&mut self)

Mark this Room as left

source

pub fn mark_as_invited(&mut self)

Mark this Room as invited

source

pub fn mark_members_synced(&mut self)

Mark this Room as having all the members synced

source

pub fn mark_members_missing(&mut self)

Mark this Room still missing member information

source

pub fn set_prev_batch(&mut self, prev_batch: Option<&str>) -> bool

Set the prev_batch-token. Returns whether the token has differed and thus has been upgraded: false means no update was applied as the were the same

source

pub fn is_encrypted(&self) -> bool

Whether this is an encrypted Room

source

pub fn handle_state_event(&mut self, event: &AnySyncStateEvent) -> bool

Handle the given state event.

Returns true if the event modified the info, false otherwise.

source

pub fn handle_stripped_state_event(
&mut self,
event: &AnyStrippedStateEvent
) -> bool

Handle the given stripped state event.

Returns true if the event modified the info, false otherwise.

source

pub fn handle_redaction(&mut self, event: &OriginalSyncRoomRedactionEvent)

Handle the given redaction.

Returns true if the event modified the info, false otherwise.

source

pub fn update_notification_count(
&mut self,
notification_counts: UnreadNotificationsCount
)

Update the notifications count

source

pub fn update_summary(&mut self, summary: &RumaSummary) -> bool

Update the RoomSummary

Returns true if the Summary modified the info, false otherwise.

source

pub fn active_members_count(&self) -> u64

The number of active members (invited + joined) in the room.

The return value is saturated at u64::MAX.

source

pub fn canonical_alias(&self) -> Option<&RoomAliasId>

Get the canonical alias of this room.

source

pub fn alt_aliases(&self) -> &[OwnedRoomAliasId]

Get the alternative aliases of this room.

source

pub fn room_id(&self) -> &RoomId

Get the room ID of this room.

source

pub fn room_version(&self) -> Option<&RoomVersionId>

Get the room version of this room.

source

pub fn room_type(&self) -> Option<&CreateRoomType>

Get the room type of this room.

Trait Implementations

source

impl Clone for RoomInfo

source

fn clone(&self) -> RoomInfo

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 RoomInfo

source

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

Formats the value using the given formatter. Read more

source

impl<'de> Deserialize<'de> for RoomInfo

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl Serialize for RoomInfo

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

impl RefUnwindSafe for RoomInfo

impl Send for RoomInfo

impl Sync for RoomInfo

impl Unpin for RoomInfo

impl UnwindSafe for RoomInfo

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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 for T where
U: From<T>,

const: unstable · 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> Same<T> for T

type Output = T

Should always be Self

source

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

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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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> AsyncTraitDeps for T where
T: Debug + Send + Sync,

source

Struct matrix_sdk_base::RoomInfo

Implementations

impl RoomInfo

pub fn mark_as_joined(&mut self)

pub fn mark_as_left(&mut self)

pub fn mark_as_invited(&mut self)

pub fn mark_members_synced(&mut self)

pub fn mark_members_missing(&mut self)

pub fn set_prev_batch(&mut self, prev_batch: Option<&str>) -> bool

pub fn is_encrypted(&self) -> bool

pub fn handle_state_event(&mut self, event: &AnySyncStateEvent) -> bool

pub fn handle_stripped_state_event( &mut self, event: &AnyStrippedStateEvent) -> bool

pub fn handle_redaction(&mut self, event: &OriginalSyncRoomRedactionEvent)

pub fn update_notification_count( &mut self, notification_counts: UnreadNotificationsCount)

pub fn update_summary(&mut self, summary: &RumaSummary) -> bool

pub fn active_members_count(&self) -> u64

pub fn canonical_alias(&self) -> Option<&RoomAliasId>

pub fn alt_aliases(&self) -> &[OwnedRoomAliasId]

pub fn room_id(&self) -> &RoomId

pub fn room_version(&self) -> Option<&RoomVersionId>

pub fn room_type(&self) -> Option<&CreateRoomType>

Trait Implementations

impl Clone for RoomInfo

fn clone(&self) -> RoomInfo

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

impl Debug for RoomInfo

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

impl<'de> Deserialize<'de> for RoomInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where __D: Deserializer<'de>,

impl Serialize for RoomInfo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where __S: Serializer,

Auto Trait Implementations

impl RefUnwindSafe for RoomInfo

impl Send for RoomInfo

impl Sync for RoomInfo

impl Unpin for RoomInfo

impl UnwindSafe for RoomInfo

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> AsyncTraitDeps for T where T: Debug + Send + Sync,

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,

pub fn handle_stripped_state_event(
&mut self,
event: &AnyStrippedStateEvent
) -> bool

pub fn update_notification_count(
&mut self,
notification_counts: UnreadNotificationsCount
)

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

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

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

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

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

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

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

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

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

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

impl<T> AsyncTraitDeps for T where
T: Debug + Send + Sync,

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,