Struct fractal::session::model::room::imp::Room

pub struct Room {

    pub matrix_room: OnceCell<Room>,
    pub session: WeakRef<Session>,
    pub room_id_string: PhantomData<String>,
    pub aliases: RoomAliases,
    pub version: PhantomData<String>,
    pub federated: PhantomData<bool>,
    pub name: PhantomData<Option<String>>,
    pub has_avatar: Cell<bool>,
    pub category: Cell<RoomType>,
    pub timeline: OnceCell<Timeline>,
    pub own_member: OnceCell<Member>,
    pub members: WeakRef<MemberList>,
    pub joined_members_count: Cell<u64>,
    pub inviter: RefCell<Option<Member>>,
    pub permissions: Permissions,
    pub latest_activity: Cell<u64>,
    pub is_read: Cell<bool>,
    pub highlight: Cell<HighlightFlags>,
    pub predecessor_id: OnceCell<OwnedRoomId>,
    pub predecessor_id_string: PhantomData<Option<String>>,
    pub successor_id: OnceCell<OwnedRoomId>,
    pub successor_id_string: PhantomData<Option<String>>,
    pub successor: WeakRef<Room>,
    pub verification: BoundObjectWeakRef<IdentityVerification>,
    pub is_encrypted: Cell<bool>,
    pub typing_list: TypingList,
    pub is_direct: Cell<bool>,
    pub direct_member: RefCell<Option<Member>>,
    pub notification_count: PhantomData<u64>,
    pub topic: PhantomData<Option<String>>,
    pub topic_linkified: RefCell<Option<String>>,
    pub is_tombstoned: PhantomData<bool>,
    pub notifications_setting: Cell<NotificationsRoomSetting>,
    pub join_rule: JoinRule,
    pub guests_allowed: Cell<bool>,
    pub history_visibility: Cell<HistoryVisibilityValue>,
    pub typing_drop_guard: OnceCell<EventHandlerDropGuard>,
}

Fields

matrix_room: OnceCell<Room>

The room API of the SDK.

session: WeakRef<Session>

The current session.

room_id_string: PhantomData<String>

The ID of this room, as a string.

aliases: RoomAliases

The aliases of this room.

version: PhantomData<String>

The version of this room.

federated: PhantomData<bool>

Whether this room is federated.

name: PhantomData<Option<String>>

The name that is set for this room.

This can be empty, the display name should be used instead in the interface.

has_avatar: Cell<bool>

Whether this room has an avatar explicitly set.

This is false if there is no avatar or if the avatar is the one from the other member.

category: Cell<RoomType>

The category of this room.

timeline: OnceCell<Timeline>

The timeline of this room.

own_member: OnceCell<Member>

The member corresponding to our own user.

members: WeakRef<MemberList>

The members of this room.

joined_members_count: Cell<u64>

The number of joined members in the room, according to the homeserver.

inviter: RefCell<Option<Member>>

The user who sent the invite to this room.

This is only set when this room is an invitation.

permissions: Permissions

The permissions of our own user in this room

latest_activity: Cell<u64>

The timestamp of the room’s latest activity.

This is the timestamp of the latest event that counts as possibly unread.

If it is not known, it will return 0.

is_read: Cell<bool>

Whether all messages of this room are read.

highlight: Cell<HighlightFlags>

The highlight state of the room.

predecessor_id: OnceCell<OwnedRoomId>

The ID of the room that was upgraded and that this one replaces.

predecessor_id_string: PhantomData<Option<String>>

The ID of the room that was upgraded and that this one replaces, as a string.

successor_id: OnceCell<OwnedRoomId>

The ID of the successor of this Room, if this room was upgraded.

successor_id_string: PhantomData<Option<String>>

The ID of the successor of this Room, if this room was upgraded, as a string.

successor: WeakRef<Room>

The successor of this Room, if this room was upgraded and the successor was joined.

verification: BoundObjectWeakRef<IdentityVerification>

An ongoing identity verification in this room.

is_encrypted: Cell<bool>

Whether this room is encrypted.

typing_list: TypingList

The list of members currently typing in this room.

is_direct: Cell<bool>

Whether this room is a direct chat.

direct_member: RefCell<Option<Member>>

The other member of the room, if this room is a direct chat and there is only one other member.

notification_count: PhantomData<u64>

The number of unread notifications of this room.

topic: PhantomData<Option<String>>

The topic of this room.

topic_linkified: RefCell<Option<String>>

The linkified topic of this room.

This is the string that should be used in the interface when markup is allowed.

is_tombstoned: PhantomData<bool>

Whether this room has been upgraded.

notifications_setting: Cell<NotificationsRoomSetting>

The notifications settings for this room.

join_rule: JoinRule

The join rule of this room.

guests_allowed: Cell<bool>

Whether guests are allowed.

history_visibility: Cell<HistoryVisibilityValue>

The visibility of the history.

typing_drop_guard: OnceCell<EventHandlerDropGuard>

Implementations

impl Room

fn register_type()

Registers the type only once.

impl Room

pub fn downgrade(&self) -> <Self as Downgrade>::Weak

impl Room

fn set_session(&self, session: Session)

Set the current session

pub fn matrix_room(&self) -> &MatrixRoom

The room API of the SDK.

fn room_id_string(&self) -> String

The room ID of this room, as a string.

fn version(&self) -> String

The version of this room.

fn federated(&self) -> bool

Whether this room is federated.

fn name(&self) -> Option<String>

The name of this room.

This can be empty, the display name should be used instead in the interface.

pub fn set_has_avatar(&self, has_avatar: bool)

Set whether this room has an avatar explicitly set.

fn notification_count(&self) -> u64

The number of unread notifications of this room.

fn topic(&self) -> Option<String>

The topic of this room.

pub(super) fn update_topic(&self)

Update the topic of this room.

fn is_tombstoned(&self) -> bool

Whether this room was tombstoned.

fn predecessor_id_string(&self) -> Option<String>

The ID of the room that was upgraded and that this one replaces, as a string.

fn successor_id_string(&self) -> Option<String>

The ID of the successor of this Room, if this room was upgraded.

fn set_verification(&self, verification: Option<IdentityVerification>)

Set an ongoing verification in this room.

fn set_notifications_setting(&self, setting: NotificationsRoomSetting)

Set the notifications setting for this room.

pub(super) async fn watch_send_queue(&self)

Watch errors in the send queue to try to handle them.

Trait Implementations

impl Default for Room

fn default() -> Room

Returns the “default value” for a type.

impl DerivedObjectProperties for Room

fn derived_properties() -> &'static [ParamSpec]

Properties installed for this type.

fn derived_property(&self, id: usize, pspec: &ParamSpec) -> Value

Similar to ObjectImpl but auto-generated by the Properties macro to allow handling more complex use-cases.

fn derived_set_property(&self, id: usize, value: &Value, pspec: &ParamSpec)

Similar to ObjectImpl but auto-generated by the Properties macro to allow handling more complex use-cases.

impl ObjectImpl for Room

fn signals() -> &'static [Signal]

Signals installed for this type.

fn properties() -> &'static [ParamSpec]

Properties installed for this type.

fn set_property(&self, id: usize, value: &Value, pspec: &ParamSpec)

Property setter.

fn property(&self, id: usize, pspec: &ParamSpec) -> Value

Property getter.

fn constructed(&self)

Constructed.

fn dispose(&self)

Disposes of the object.

fn notify(&self, pspec: &ParamSpec)

Function to be called when property change is notified for with self.notify("property").

fn dispatch_properties_changed(&self, pspecs: &[ParamSpec])

impl ObjectSubclass for Room

type Interfaces = ()

List of interfaces implemented by this type.

type Class = ClassStruct<Room>

The C class struct.

type Instance = InstanceStruct<Room>

The C instance struct.

fn new() -> Self

Constructor.

const NAME: &'static str = "Room"

GObject type name.

type Type = Room

Wrapper around this subclass defined with wrapper!

type ParentType = PillSource

Parent Rust type to inherit from.

const ABSTRACT: bool = false

If this subclass is an abstract class or not.

const ALLOW_NAME_CONFLICT: bool = false

Allow name conflicts for this class.

fn type_init(_type_: &mut InitializingType<Self>)

Additional type initialization.

fn class_init(_klass: &mut Self::Class)

Class initialization.

fn with_class(_klass: &Self::Class) -> Self

Constructor.

fn instance_init(_obj: &InitializingObject<Self>)

Performs additional instance initialization.

impl ObjectSubclassType for Room

fn type_data() -> NonNull<TypeData>

Storage for the type-specific data used during registration.

fn type_() -> Type

Returns the glib::Type ID of the subclass.

impl PillSourceImpl for Room

fn identifier(&self) -> String

A unique identifier for this source.