Struct Session 

#[repr(transparent)]
pub struct Session {
    inner: TypedObjectRef<Session, <Session as ObjectSubclass>::ParentType>,
    phantom: PhantomData<()>,
}

A Matrix user session.

GLib type: GObject with reference counted clone semantics.

Fields

inner: TypedObjectRef<Session, <Session as ObjectSubclass>::ParentType>

phantom: PhantomData<()>

Implementations

impl Session

pub fn sidebar_list_model( &self, ) -> <OnceCell<SidebarListModel> as Property>::Value

The list model of the sidebar.

pub fn user(&self) -> <OnceCell<User> as Property>::Value

The user of this session.

pub fn state(&self) -> <Cell<SessionState> as Property>::Value

The current state of the session.

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

Whether this session has a connection to the homeserver.

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

Whether this session is synchronized with the homeserver.

pub fn settings(&self) -> <OnceCell<SessionSettings> as Property>::Value

The current settings for this session.

pub fn global_account_data( &self, ) -> <OnceCell<GlobalAccountData> as Property>::Value

The settings in the global account data for this session.

pub fn notifications(&self) -> <Notifications as Property>::Value

The notifications API for this session.

pub fn ignored_users(&self) -> <IgnoredUsers as Property>::Value

The ignored users API for this session.

pub fn user_sessions(&self) -> <UserSessionsList as Property>::Value

The list of sessions for this session’s user.

pub fn security(&self) -> <SessionSecurity as Property>::Value

Information about security for this session.

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

Listen for notifications of a change in the sidebar-list-model property

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

Listen for notifications of a change in the user property

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

Listen for notifications of a change in the state property

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

Listen for notifications of a change in the is-homeserver-reachable property

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

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

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

Listen for notifications of a change in the settings property

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

Listen for notifications of a change in the global-account-data property

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

Listen for notifications of a change in the notifications property

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

Listen for notifications of a change in the ignored-users property

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

Listen for notifications of a change in the user-sessions property

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

Listen for notifications of a change in the security property

pub fn notify_sidebar_list_model(&self)

Notify listeners of a change in the sidebar-list-model property

pub fn notify_user(&self)

Notify listeners of a change in the user property

pub fn notify_state(&self)

Notify listeners of a change in the state property

pub fn notify_is_homeserver_reachable(&self)

Notify listeners of a change in the is-homeserver-reachable property

pub fn notify_is_offline(&self)

Notify listeners of a change in the is-offline property

pub fn notify_settings(&self)

Notify listeners of a change in the settings property

pub fn notify_global_account_data(&self)

Notify listeners of a change in the global-account-data property

pub fn notify_notifications(&self)

Notify listeners of a change in the notifications property

pub fn notify_ignored_users(&self)

Notify listeners of a change in the ignored-users property

pub fn notify_user_sessions(&self)

Notify listeners of a change in the user-sessions property

pub fn notify_security(&self)

Notify listeners of a change in the security property

impl Session

pub(crate) async fn new( stored_session: StoredSession, settings: SessionSettings, ) -> Result<Self, ClientSetupError>

Construct an existing session.

pub(crate) async fn create(client: &Client) -> Result<Self, ClientSetupError>

Create a new session from the session of the given Matrix client.

pub(crate) async fn prepare(&self)

Finish initialization of this session.

pub(crate) fn room_list(&self) -> RoomList

The room list of this session.

pub(crate) fn verification_list(&self) -> VerificationList

The verification list of this session.

pub(crate) fn client(&self) -> Client

The Matrix client.

pub(crate) fn remote_cache(&self) -> &RemoteCache

The cache for remote data.

pub(crate) async fn log_out(&self) -> Result<(), String>

Log out of this session.

pub(crate) async fn clean_up(&self)

Clean up this session after it was logged out.

This should only be called if the session has been logged out without calling Session::log_out.

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

Connect to the signal emitted when this session is logged out.

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

Connect to the signal emitted when this session is ready.

Trait Implementations

impl Clone for Session

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 Session

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

Formats the value using the given formatter.

impl HasParamSpec for Session

type ParamSpec = ParamSpecObject

type SetValue = Session

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Session

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 Session

type Subclass = Session

impl Ord for Session

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 Session

type Parent = SessionInfo

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

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 Session

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 Session

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Session

impl IsA<SessionInfo> for Session