Struct RoomAliases

#[repr(transparent)]
pub struct RoomAliases {
    inner: TypedObjectRef<RoomAliases, ()>,
    phantom: PhantomData<()>,
}

Aliases of a room.

GLib type: GObject with reference counted clone semantics.

Fields

inner: TypedObjectRef<RoomAliases, ()>

phantom: PhantomData<()>

Implementations

impl RoomAliases

pub fn room(&self) -> <WeakRef<Room> as Property>::Value

pub fn canonical_alias_string( &self, ) -> <PhantomData<Option<String>> as Property>::Value

pub fn alt_aliases_model(&self) -> <StringList as Property>::Value

pub fn alias_string(&self) -> <PhantomData<Option<String>> as Property>::Value

pub fn connect_room_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_canonical_alias_string_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_alt_aliases_model_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_alias_string_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn notify_room(&self)

pub fn notify_canonical_alias_string(&self)

pub fn notify_alt_aliases_model(&self)

pub fn notify_alias_string(&self)

impl RoomAliases

pub fn new() -> Self

pub(crate) fn init(&self, room: &Room)

Initialize these aliases with the given room.

pub(crate) fn update(&self)

Update the aliases with the SDK data.

async fn canonical_alias_event_content( &self, ) -> Result<Option<RoomCanonicalAliasEventContent>, ()>

Get the content of the canonical alias event from the store.

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

The canonical alias.

pub(crate) async fn remove_canonical_alias( &self, alias: &OwnedRoomAliasId, ) -> Result<(), ()>

Remove the given canonical alias.

Checks that the canonical alias is the correct one before proceeding.

pub(crate) async fn set_canonical_alias( &self, alias: OwnedRoomAliasId, ) -> Result<(), ()>

Set the given alias to be the canonical alias.

Removes the given alias from the alt aliases if it is in the list.

pub(crate) fn alt_aliases(&self) -> Vec<OwnedRoomAliasId>

The other public aliases.

pub(crate) async fn remove_alt_alias( &self, alias: &OwnedRoomAliasId, ) -> Result<(), ()>

Remove the given alt alias.

Checks that is in the list of alt aliases before proceeding.

pub(crate) async fn add_alt_alias( &self, alias: OwnedRoomAliasId, ) -> Result<(), AddAltAliasError>

Set the given alias to be an alt alias.

Removes the given alias from the alt aliases if it is in the list.

pub(crate) fn alias(&self) -> Option<OwnedRoomAliasId>

The main alias.

This is the canonical alias if there is one, of the first of the alt aliases.

pub(crate) async fn local_aliases(&self) -> Result<Vec<OwnedRoomAliasId>, ()>

Get the local aliases registered on the homeserver.

pub(crate) async fn unregister_local_alias( &self, alias: OwnedRoomAliasId, ) -> Result<(), ()>

Unregister the given local alias.

pub(crate) async fn register_local_alias( &self, alias: OwnedRoomAliasId, ) -> Result<(), RegisterLocalAliasError>

Register the given local alias.

pub(crate) fn connect_changed<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Connect to the signal emitted when the aliases changed.

Trait Implementations

impl Clone for RoomAliases

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for RoomAliases

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

Formats the value using the given formatter.

impl Default for RoomAliases

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for RoomAliases

type ParamSpec = ParamSpecObject

type SetValue = RoomAliases

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, RoomAliases>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for RoomAliases

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl ObjectSubclassIs for RoomAliases

type Subclass = RoomAliases

impl Ord for RoomAliases

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for RoomAliases

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for RoomAliases

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for RoomAliases

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for RoomAliases

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for RoomAliases