Struct Session 

pub struct Session {

    client: OnceCell<TokioDrop<Client>>,
    sidebar_list_model: OnceCell<SidebarListModel>,
    user: OnceCell<User>,
    state: Cell<SessionState>,
    is_homeserver_reachable: Cell<bool>,
    is_offline: Cell<bool>,
    settings: OnceCell<SessionSettings>,
    global_account_data: OnceCell<GlobalAccountData>,
    notifications: Notifications,
    ignored_users: IgnoredUsers,
    user_sessions: UserSessionsList,
    security: SessionSecurity,
    remote_cache: OnceCell<RemoteCache>,
    session_changes_handle: RefCell<Option<AbortHandle>>,
    sync_handle: RefCell<Option<AbortHandle>>,
    network_monitor_handler_id: RefCell<Option<SignalHandlerId>>,
    homeserver_reachable_lock: Mutex<()>,
    homeserver_reachable_source: RefCell<Option<SourceId>>,
    missed_sync_count: Cell<usize>,
}

Fields

client: OnceCell<TokioDrop<Client>>

The Matrix client for this session.

sidebar_list_model: OnceCell<SidebarListModel>

The list model of the sidebar.

user: OnceCell<User>

The user of this session.

state: Cell<SessionState>

The current state of the session.

is_homeserver_reachable: Cell<bool>

Whether this session has a connection to the homeserver.

is_offline: Cell<bool>

Whether this session is synchronized with the homeserver.

settings: OnceCell<SessionSettings>

The current settings for this session.

global_account_data: OnceCell<GlobalAccountData>

The settings in the global account data for this session.

notifications: Notifications

The notifications API for this session.

ignored_users: IgnoredUsers

The ignored users API for this session.

user_sessions: UserSessionsList

The list of sessions for this session’s user.

security: SessionSecurity

Information about security for this session.

remote_cache: OnceCell<RemoteCache>

The cache for remote data.

session_changes_handle: RefCell<Option<AbortHandle>>

sync_handle: RefCell<Option<AbortHandle>>

network_monitor_handler_id: RefCell<Option<SignalHandlerId>>

homeserver_reachable_lock: Mutex<()>

homeserver_reachable_source: RefCell<Option<SourceId>>

missed_sync_count: Cell<usize>

The number of missed synchronizations in a row.

Capped at MISSED_SYNC_DELAYS.len() - 1.

Implementations

impl Session

fn register_type()

Registers the type only once.

impl Session

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

impl Session

pub(super) fn set_client(&self, client: Client)

Set the Matrix client for this session.

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

The Matrix client for this session.

fn sidebar_list_model(&self) -> SidebarListModel

The list model of the sidebar.

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

The room list of this session.

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

The verification list of this session.

fn user(&self) -> User

The user of the session.

fn set_state(&self, state: SessionState)

Set the current state of the session.

fn homeserver_address(&self) -> NetworkAddress

The homeserver URL as a GNetworkAddress.

pub(super) async fn update_homeserver_reachable(&self)

Check whether the homeserver is reachable.

fn set_is_homeserver_reachable(&self, is_reachable: bool)

Set whether the homeserver is reachable.

pub(super) fn set_offline(&self, is_offline: bool)

Set whether this session is synchronized with the homeserver.

fn global_account_data(&self) -> &GlobalAccountData

The settings stored in the global account data for this session.

fn global_account_data_owned(&self) -> GlobalAccountData

The owned settings stored in the global account data for this session.

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

The cache for remote data.

pub(super) async fn prepare(&self)

Finish initialization of this session.

fn watch_session_changes(&self)

Watch the changes of the session, like being logged out or the tokens being refreshed.

fn sync(&self)

Start syncing the Matrix client.

fn handle_sync_response( &self, response: Result<SyncResponse, Error>, ) -> Option<Duration>

Handle the response received via sync.

Returns the delay to wait for before making the next sync, if necessary.

async fn init_user_profile(&self)

Load the cached profile of the user of this session.

async fn update_user_profile(&self)

Update the profile of this session’s user.

Fetches the updated profile and updates the local data.

fn init_notifications(&self)

Start listening to notifications.

async fn store_tokens(&self)

Update the stored session tokens.

pub(super) 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.

Trait Implementations

impl Debug for Session

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

Formats the value using the given formatter.

impl Default for Session

fn default() -> Session

Returns the “default value” for a type.

impl DerivedObjectProperties for Session

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 Session

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 signals() -> &'static [Signal]

Signals installed for this type.

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 Session

const NAME: &'static str = "Session"

GObject type name.

type Interfaces = ()

List of interfaces implemented by this type.

type Class = ClassStruct<Session>

The C class struct.

type Instance = InstanceStruct<Session>

The C instance struct.

type Type = Session

Wrapper around this subclass defined with wrapper!

type ParentType = SessionInfo

Parent Rust type to inherit from.

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 Session

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.

impl SessionInfoImpl for Session

fn avatar_data(&self) -> AvatarData