Struct RemoteRoom 

pub struct RemoteRoom {

    session: WeakRef<Session>,
    uri: OnceCell<MatrixRoomIdUri>,
    room_id: RefCell<Option<OwnedRoomId>>,
    canonical_alias: RefCell<Option<OwnedRoomAliasId>>,
    name: RefCell<Option<String>>,
    topic: RefCell<Option<String>>,
    topic_linkified: RefCell<Option<String>>,
    joined_members_count: Cell<u32>,
    can_knock: Cell<bool>,
    room_list_info: RoomListRoomInfo,
    loading_state: Cell<LoadingState>,
    last_request_time: Cell<Option<Instant>>,
    request_abort_handle: AbortableHandle,
}

Fields

session: WeakRef<Session>

The current session.

uri: OnceCell<MatrixRoomIdUri>

The Matrix URI of this room.

room_id: RefCell<Option<OwnedRoomId>>

The ID of this room.

canonical_alias: RefCell<Option<OwnedRoomAliasId>>

The canonical alias of this room.

name: RefCell<Option<String>>

The name that is set for this room.

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

topic: RefCell<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.

joined_members_count: Cell<u32>

The number of joined members in the room.

can_knock: Cell<bool>

Whether we can knock on the room.

room_list_info: RoomListRoomInfo

The information about this room in the room list.

loading_state: Cell<LoadingState>

The loading state.

last_request_time: Cell<Option<Instant>>

The time of the last request.

request_abort_handle: AbortableHandle

Implementations

impl RemoteRoom

fn register_type()

Registers the type only once.

impl RemoteRoom

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

impl RemoteRoom

fn set_session(&self, session: &Session)

Set the current session.

pub(super) fn set_uri(&self, uri: MatrixRoomIdUri)

Set the Matrix URI of this room.

pub(super) fn uri(&self) -> &MatrixRoomIdUri

The Matrix URI of this room.

fn set_room_id(&self, room_id: OwnedRoomId)

Set the ID of this room.

pub(super) fn room_id(&self) -> Option<OwnedRoomId>

The ID of this room.

fn set_canonical_alias(&self, alias: Option<OwnedRoomAliasId>)

Set the canonical alias of this room.

pub(super) fn canonical_alias(&self) -> Option<OwnedRoomAliasId>

The canonical alias of this room.

fn update_identifiers(&self)

Update the identifiers to watch in the room list.

fn set_name(&self, name: Option<String>)

Set the name of this room.

pub(super) fn update_display_name(&self)

The display name of this room.

fn set_topic(&self, topic: Option<String>)

Set the topic of this room.

fn set_joined_members_count(&self, count: u32)

Set the number of joined members in the room.

fn set_join_rule(&self, join_rule: &JoinRuleSummary)

Set the join rule of the room.

pub(super) fn set_loading_state(&self, loading_state: LoadingState)

Set the loading state.

pub(super) fn set_data(&self, data: RoomSummary)

Set the room data.

pub(super) fn is_data_stale(&self) -> bool

Whether the data of the room is considered to be stale.

pub(super) fn update_last_request_time(&self)

Update the last request time to now.

pub(super) async fn load_data(&self)

Request the data of this room.

async fn load_data_from_summary(&self, session: &Session) -> bool

Load the data of this room using the room summary endpoint.

At the time of writing this code, MSC3266 has been accepted but the endpoint is not part of a Matrix spec release.

Returns false if the endpoint is not supported by the homeserver.

async fn load_data_from_space_hierarchy(&self, session: &Session)

Load the data of this room using the space hierarchy endpoint.

This endpoint should work for any room already known by the homeserver.

Trait Implementations

impl Default for RemoteRoom

fn default() -> RemoteRoom

Returns the “default value” for a type.

impl DerivedObjectProperties for RemoteRoom

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 RemoteRoom

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 signals() -> &'static [Signal]

Signals installed for this type.

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 RemoteRoom

const NAME: &'static str = "RemoteRoom"

GObject type name.

type Interfaces = ()

List of interfaces implemented by this type.

type Class = ClassStruct<RemoteRoom>

The C class struct.

type Instance = InstanceStruct<RemoteRoom>

The C instance struct.

type Type = RemoteRoom

Wrapper around this subclass defined with wrapper!

type ParentType = PillSource

Parent Rust type to inherit from.

fn new() -> Self

Constructor.

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 RemoteRoom

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 RemoteRoom

fn identifier(&self) -> String

A unique identifier for this source.