Trait Session 

pub trait Session:
    Send
    + Sync
    + 'static {
    type Error;

    // Required methods
    fn home_dc_id(&self) -> Result<i32, Self::Error>;
    fn set_home_dc_id(
        &self,
        dc_id: i32,
    ) -> BoxFuture<'_, Result<(), Self::Error>>;
    fn dc_option(&self, dc_id: i32) -> Result<Option<DcOption>, Self::Error>;
    fn set_dc_option(
        &self,
        dc_option: &DcOption,
    ) -> BoxFuture<'_, Result<(), Self::Error>>;
    fn peer(
        &self,
        peer: PeerId,
    ) -> BoxFuture<'_, Result<Option<PeerInfo>, Self::Error>>;
    fn cache_peer(
        &self,
        peer: &PeerInfo,
    ) -> BoxFuture<'_, Result<(), Self::Error>>;
    fn updates_state(&self) -> BoxFuture<'_, Result<UpdatesState, Self::Error>>;
    fn set_update_state(
        &self,
        update: UpdateState,
    ) -> BoxFuture<'_, Result<(), Self::Error>>;

    // Provided method
    fn peer_ref(
        &self,
        peer: PeerId,
    ) -> BoxFuture<'_, Result<Option<PeerRef>, Self::Error>> { ... }
}

The main interface to interact with the different crate::storages.

All methods are synchronous and currently infallible because clients are not equipped to deal with the arbitrary errors that a dynamic Session could produce. This may change in the future.

A newly-created storage should return the same values that crate::SessionData::default would produce.

Required Associated Types

type Error

Required Methods

fn home_dc_id(&self) -> Result<i32, Self::Error>

Datacenter that is “home” to the user authorized by this session.

If not known, the ID of the closest datacenter should be returned instead. Note that incorrect guesses are allowed, and the user may need to migrate.

Note that it is used on every request and thus should be cheap to call.

fn set_home_dc_id(&self, dc_id: i32) -> BoxFuture<'_, Result<(), Self::Error>>

Changes the Session::home_dc_id after finding out the actual datacenter to which main queries should be executed against.

This must update the value in the cache layer used by home_dc_id.

fn dc_option(&self, dc_id: i32) -> Result<Option<DcOption>, Self::Error>

Query a single datacenter option.

If no up-to-date option has been Session::set_dc_option yet, a statically-known option must be returned.

None may only be returned on invalid DC IDs or DCs that are not yet known.

Note that it is used on every request and thus should be cheap to call.

fn set_dc_option( &self, dc_option: &DcOption, ) -> BoxFuture<'_, Result<(), Self::Error>>

Update the previously-known Session::dc_option with new values.

Should also be used after generating permanent authentication keys to a datacenter.

This must update the value in the cache layer used by dc_option.

fn peer( &self, peer: PeerId, ) -> BoxFuture<'_, Result<Option<PeerInfo>, Self::Error>>

Query a peer by its identity.

Querying for PeerId::self_user can be used as a way to determine whether the authentication key has a logged-in user bound (i.e. signed in).

fn cache_peer(&self, peer: &PeerInfo) -> BoxFuture<'_, Result<(), Self::Error>>

Cache a peer’s basic information for Session::peer to be able to query them later.

This method may not necessarily remember the peers forever, except for users where PeerInfo::User::is_self is Some(true).

fn updates_state(&self) -> BoxFuture<'_, Result<UpdatesState, Self::Error>>

Loads the entire updates state.

fn set_update_state( &self, update: UpdateState, ) -> BoxFuture<'_, Result<(), Self::Error>>

Update the state for one or all updates.

Provided Methods

fn peer_ref( &self, peer: PeerId, ) -> BoxFuture<'_, Result<Option<PeerRef>, Self::Error>>

Query the full peer reference from its identity.

By default, this uses Session::peer to retrieve the PeerAuth.

If you want to obtain a PeerRef from a PeerId regardless of whether it is cached in the session or not, you can pair this method with PeerId::to_ambient_ref.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl Session for MemorySession

type Error = MemorySessionError

impl Session for SqliteSession

type Error = SqliteSessionError