Struct JoinRule

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

The join rule of a room.

GLib type: GObject with reference counted clone semantics.

Fields

inner: TypedObjectRef<JoinRule, ()>

phantom: PhantomData<()>

Implementations

impl JoinRule

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

The room where this join rule apply.

pub fn value(&self) -> <Cell<JoinRuleValue> as Property>::Value

The value of the join rule.

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

Whether users can knock.

pub fn display_name(&self) -> <RefCell<String> as Property>::Value

The string to use to display this join rule.

This string can contain markup.

pub fn membership_room(&self) -> <BoundObject<PillSource> as Property>::Value

The room we need to be a member of to match this join rule, if any.

This can be a Room or a RemoteRoom.

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

Whether our own user can join this room on their own.

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

Whether anyone can join this room on their own.

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_value_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Listen for notifications of a change in the value property

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

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

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

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

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

Listen for notifications of a change in the membership-room property

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

Listen for notifications of a change in the we-can-join property

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

Listen for notifications of a change in the anyone-can-join property

pub fn notify_room(&self)

Notify listeners of a change in the room property

pub fn notify_value(&self)

Notify listeners of a change in the value property

pub fn notify_can_knock(&self)

Notify listeners of a change in the can-knock property

pub fn notify_display_name(&self)

Notify listeners of a change in the display-name property

pub fn notify_membership_room(&self)

Notify listeners of a change in the membership-room property

pub fn notify_we_can_join(&self)

Notify listeners of a change in the we-can-join property

pub fn notify_anyone_can_join(&self)

Notify listeners of a change in the anyone-can-join property

impl JoinRule

pub fn new() -> Self

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

Initialize the join rule with the room where it applies.

pub(super) fn update(&self, join_rule: Option<&MatrixJoinRule>)

Update the join rule with the given value from the SDK.

pub(crate) async fn set_value(&self, value: JoinRuleValue) -> Result<(), ()>

Change the value of the join rule.

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

Connect to the signal emitted when the join rule changed.

Trait Implementations

impl Clone for JoinRule

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 JoinRule

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

Formats the value using the given formatter.

impl Default for JoinRule

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for JoinRule

type ParamSpec = ParamSpecObject

type SetValue = JoinRule

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for JoinRule

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 JoinRule

type Subclass = JoinRule

impl Ord for JoinRule

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 JoinRule

type Parent = Object

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

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 JoinRule

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 JoinRule

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for JoinRule