Struct Permissions

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

The permissions of our own user in a room.

GLib type: GObject with reference counted clone semantics.

Fields

inner: TypedObjectRef<Permissions, ()>

phantom: PhantomData<()>

Implementations

impl Permissions

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

The room where these permissions apply.

pub fn is_joined(&self) -> <Cell<bool> as Property>::Value

Whether our own member is joined.

pub fn own_power_level(&self) -> <Cell<i64> as Property>::Value

The power level of our own member.

pub fn default_power_level(&self) -> <Cell<i64> as Property>::Value

The default power level for members.

pub fn mute_power_level(&self) -> <Cell<i64> as Property>::Value

The power level to mute members.

pub fn can_change_avatar(&self) -> <Cell<bool> as Property>::Value

Whether our own member can change the room’s avatar.

pub fn can_change_name(&self) -> <Cell<bool> as Property>::Value

Whether our own member can change the room’s name.

pub fn can_change_topic(&self) -> <Cell<bool> as Property>::Value

Whether our own member can change the room’s topic.

pub fn can_invite(&self) -> <Cell<bool> as Property>::Value

Whether our own member can invite another user.

pub fn can_send_message(&self) -> <Cell<bool> as Property>::Value

Whether our own member can send a message.

pub fn can_send_reaction(&self) -> <Cell<bool> as Property>::Value

Whether our own member can send a reaction.

pub fn can_redact_own(&self) -> <Cell<bool> as Property>::Value

Whether our own member can redact their own event.

pub fn can_redact_other(&self) -> <Cell<bool> as Property>::Value

Whether our own member can redact the event of another user.

pub fn can_notify_room(&self) -> <Cell<bool> as Property>::Value

Whether our own member can notify the whole room.

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

Listen for notifications of a change in the room property

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

Listen for notifications of a change in the is-joined property

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

Listen for notifications of a change in the own-power-level property

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

Listen for notifications of a change in the default-power-level property

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

Listen for notifications of a change in the mute-power-level property

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

Listen for notifications of a change in the can-change-avatar property

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

Listen for notifications of a change in the can-change-name property

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

Listen for notifications of a change in the can-change-topic property

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

Listen for notifications of a change in the can-invite property

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

Listen for notifications of a change in the can-send-message property

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

Listen for notifications of a change in the can-send-reaction property

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

Listen for notifications of a change in the can-redact-own property

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

Listen for notifications of a change in the can-redact-other property

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

Listen for notifications of a change in the can-notify-room property

pub fn notify_room(&self)

Notify listeners of a change in the room property

pub fn notify_is_joined(&self)

Notify listeners of a change in the is-joined property

pub fn notify_own_power_level(&self)

Notify listeners of a change in the own-power-level property

pub fn notify_default_power_level(&self)

Notify listeners of a change in the default-power-level property

pub fn notify_mute_power_level(&self)

Notify listeners of a change in the mute-power-level property

pub fn notify_can_change_avatar(&self)

Notify listeners of a change in the can-change-avatar property

pub fn notify_can_change_name(&self)

Notify listeners of a change in the can-change-name property

pub fn notify_can_change_topic(&self)

Notify listeners of a change in the can-change-topic property

pub fn notify_can_invite(&self)

Notify listeners of a change in the can-invite property

pub fn notify_can_send_message(&self)

Notify listeners of a change in the can-send-message property

pub fn notify_can_send_reaction(&self)

Notify listeners of a change in the can-send-reaction property

pub fn notify_can_redact_own(&self)

Notify listeners of a change in the can-redact-own property

pub fn notify_can_redact_other(&self)

Notify listeners of a change in the can-redact-other property

pub fn notify_can_notify_room(&self)

Notify listeners of a change in the can-notify-room property

impl Permissions

pub fn new() -> Self

pub(super) async fn init(&self, room: &Room)

Set our own member.

pub(crate) fn power_levels(&self) -> RoomPowerLevels

The source of the power levels information.

pub(crate) fn role(&self, power_level: i64) -> MemberRole

The current MemberRole for the given power level.

pub(crate) fn is_allowed_to(&self, room_action: PowerLevelAction) -> bool

Whether our own member is allowed to do the given action.

pub(crate) fn can_do_to_user( &self, user_id: &UserId, action: PowerLevelUserAction, ) -> bool

Whether our own user can do the given action on the user with the given ID.

pub(crate) async fn set_user_power_level( &self, user_id: OwnedUserId, power_level: i64, ) -> Result<(), ()>

Set the power level of the room member with the given user ID.

pub(crate) async fn set_power_levels( &self, power_levels: RoomPowerLevels, ) -> Result<(), ()>

Set the power levels.

pub(crate) fn user_is_allowed_to( &self, user_id: &UserId, room_action: PowerLevelAction, ) -> bool

Whether the user with the given ID is allowed to do the given action.

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

Connect to the signal emitted when the permissions changed.

Trait Implementations

impl Clone for Permissions

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 Permissions

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

Formats the value using the given formatter.

impl Default for Permissions

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for Permissions

type ParamSpec = ParamSpecObject

type SetValue = Permissions

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Permissions

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 Permissions

type Subclass = Permissions

impl Ord for Permissions

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 Permissions

type Parent = Object

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

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 Permissions

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 Permissions

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Permissions