Struct matrix_sdk_base::Session

pub struct Session {
    pub access_token: String,
    pub refresh_token: Option<String>,
    pub user_id: OwnedUserId,
    pub device_id: OwnedDeviceId,
}

A user session, containing an access token, an optional refresh token and information about the associated user account.

Example

use matrix_sdk_base::Session;
use ruma::{device_id, user_id};

let session = Session {
    access_token: "My-Token".to_owned(),
    refresh_token: None,
    user_id: user_id!("@example:localhost").to_owned(),
    device_id: device_id!("MYDEVICEID").to_owned(),
};

assert_eq!(session.device_id.as_str(), "MYDEVICEID");

Fields

access_token: String

The access token used for this session.

refresh_token: Option<String>

The token used for refreshing the access token, if any.

user_id: OwnedUserId

The user the access token was issued for.

device_id: OwnedDeviceId

The ID of the client device.

Implementations

impl Session

pub fn from_parts(meta: SessionMeta, tokens: SessionTokens) -> Self

Creates a Session from a SessionMeta and SessionTokens.

pub fn into_parts(self) -> (SessionMeta, SessionTokens)

Split this Session between SessionMeta and SessionTokens.

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a copy of the value.

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<'de> Deserialize<'de> for Session

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Response> for Session

fn from(response: Response) -> Self

Converts to this type from the input type.

impl Hash for Session

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Session> for Session

fn eq(&self, other: &Session) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Session

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Session

impl StructuralEq for Session

impl StructuralPartialEq for Session