Struct JoinRule

pub struct JoinRule {
    room: WeakRef<Room>,
    matrix_join_rule: RefCell<Option<JoinRule>>,
    value: Cell<JoinRuleValue>,
    can_knock: Cell<bool>,
    display_name: RefCell<String>,
    membership_room: BoundObject<PillSource>,
    we_can_join: Cell<bool>,
    anyone_can_join: Cell<bool>,
    own_membership_handler: RefCell<Option<SignalHandlerId>>,
}

Fields

room: WeakRef<Room>

The room where this join rule apply.

matrix_join_rule: RefCell<Option<JoinRule>>

The current join rule from the SDK.

value: Cell<JoinRuleValue>

The value of the join rule.

can_knock: Cell<bool>

Whether users can knock.

display_name: RefCell<String>

The string to use to display this join rule.

This string can contain markup.

membership_room: BoundObject<PillSource>

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

This can be a Room or a RemoteRoom.

we_can_join: Cell<bool>

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

anyone_can_join: Cell<bool>

Whether anyone can join this room on their own.

own_membership_handler: RefCell<Option<SignalHandlerId>>

Implementations

impl JoinRule

fn register_type()

Registers the type only once.

impl JoinRule

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

impl JoinRule

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

Set the room where this join rule applies.

pub(super) fn update_join_rule(&self, join_rule: &MatrixJoinRule)

Update the join rule.

fn update_value(&self)

Update the value of the join rule.

fn update_can_knock(&self)

Update whether users can knock.

fn update_membership_room(&self)

Set the room we need to be a member of to match this join rule.

fn update_display_name(&self)

Update the display name of the join rule.

fn update_we_can_join(&self)

Update whether our own user can join this room on their own.

fn we_can_join(&self) -> bool

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

fn update_anyone_can_join(&self)

Update whether our own user can join this room on their own.

Trait Implementations

impl Debug for JoinRule

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

Formats the value using the given formatter.

impl Default for JoinRule

fn default() -> JoinRule

Returns the “default value” for a type.

impl DerivedObjectProperties for JoinRule

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 JoinRule

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

Signals installed for this type.

fn dispose(&self)

Disposes of the object.

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 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 JoinRule

const NAME: &'static str = "RoomJoinRule"

GObject type name.

type ParentType = Object

Parent Rust type to inherit from.

type Interfaces = ()

List of interfaces implemented by this type.

type Class = ClassStruct<JoinRule>

The C class struct.

type Instance = InstanceStruct<JoinRule>

The C instance struct.

type Type = JoinRule

Wrapper around this subclass defined with wrapper!

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 JoinRule

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.