Struct matrix_sdk_base::store::Store

source · [−]

pub struct Store { /* private fields */ }

Expand description

A state store wrapper for the SDK.

This adds additional higher level store functionality on top of a StateStore implementation.

Implementations

source

impl Store

source

pub fn open_memory_store() -> Self

Create a new Store with the default MemoryStore

source

impl Store

source

pub fn new(inner: Arc<dyn StateStore>) -> Self

Create a new store, wrappning the given StateStore

source

pub async fn restore_session(&self, session: Session) -> Result<()>

Restore the access to the Store from the given Session, overwrites any previously existing access to the Store.

source

pub fn session(&self) -> Option<&Session>

The current Session containing our user id, device ID and access token.

source

pub fn get_rooms(&self) -> Vec<Room>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Get all the rooms this store knows about.

source

pub fn get_room(&self, room_id: &RoomId) -> Option<Room>

Get the room with the given room id.

source

pub fn get_stripped_rooms(&self) -> Vec<Room>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Get all the rooms this store knows about.

source

pub fn get_stripped_room(&self, room_id: &RoomId) -> Option<Room>

Get the stripped room with the given room id.

source

pub async fn get_or_create_stripped_room(&self, room_id: &RoomId) -> Room

Lookup the stripped Room for the given RoomId, or create one, if it didn’t exist yet in the store

source

pub async fn get_or_create_room(
    &self,
    room_id: &RoomId,
    room_type: RoomType
) -> Room

Lookup the Room for the given RoomId, or create one, if it didn’t exist yet in the store

Trait Implementations

source

impl Clone for Store

source

fn clone(&self) -> Store

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Store

source

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

Formats the value using the given formatter. Read more

source

impl Deref for Store

type Target = dyn StateStore + 'static

The resulting type after dereferencing.

source

fn deref(&self) -> &Self::Target

Dereferences the value.

Auto Trait Implementations

impl !RefUnwindSafe for Store

impl Send for Store

impl Sync for Store

impl Unpin for Store

impl !UnwindSafe for Store

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

source

Struct matrix_sdk_base::store::Store

Implementations

impl Store

pub fn open_memory_store() -> Self

impl Store

pub fn new(inner: Arc<dyn StateStore>) -> Self

pub async fn restore_session(&self, session: Session) -> Result<()>

pub fn session(&self) -> Option<&Session>

pub fn get_rooms(&self) -> Vec<Room>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn get_room(&self, room_id: &RoomId) -> Option<Room>

pub fn get_stripped_rooms(&self) -> Vec<Room>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn get_stripped_room(&self, room_id: &RoomId) -> Option<Room>

pub async fn get_or_create_stripped_room(&self, room_id: &RoomId) -> Room

pub async fn get_or_create_room( &self, room_id: &RoomId, room_type: RoomType) -> Room

Trait Implementations

impl Clone for Store

fn clone(&self) -> Store

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

impl Debug for Store

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

impl Deref for Store

type Target = dyn StateStore + 'static

fn deref(&self) -> &Self::Target

Auto Trait Implementations

impl !RefUnwindSafe for Store

impl Send for Store

impl Sync for Store

impl Unpin for Store

impl !UnwindSafe for Store

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> AsyncTraitDeps for T where T: Debug + Send + Sync,

pub fn get_rooms(&self) -> Vec<Room>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn get_stripped_rooms(&self) -> Vec<Room>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub async fn get_or_create_room(
&self,
room_id: &RoomId,
room_type: RoomType
) -> Room

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<T> AsyncTraitDeps for T where
T: Debug + Send + Sync,