Struct MatrixSession

pub struct MatrixSession {
    pub meta: SessionMeta,
    pub tokens: MatrixSessionTokens,
}

A user session using the native Matrix authentication API.

Examples

use matrix_sdk::{
    matrix_auth::{MatrixSession, MatrixSessionTokens},
    SessionMeta,
};
use ruma::{device_id, user_id};

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

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

Fields

meta: SessionMeta

The Matrix user session info.

tokens: MatrixSessionTokens

The tokens used for authentication.

Trait Implementations

impl Clone for MatrixSession

fn clone(&self) -> MatrixSession

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MatrixSession

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MatrixSession

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 MatrixSession

fn from(response: &Response) -> Self

Converts to this type from the input type.

impl From<MatrixSession> for AuthSession

fn from(session: MatrixSession) -> Self

Converts to this type from the input type.

impl Hash for MatrixSession

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MatrixSession

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

Tests for self and other values to be equal, and is used by ==.

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 Serialize for MatrixSession

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 MatrixSession

impl StructuralPartialEq for MatrixSession