Struct runa_core::client::Store

pub struct Store<Object> { /* private fields */ }

A reference object store implementation

Note

You must call Store::clear_for_disconnect before the object store is dropped. Otherwise, the object store will panic.

Implementations

impl<O> Store<O>

pub fn clear_for_disconnect<Ctx>(&mut self, server_ctx: &mut Ctx::ServerContext)where Ctx: Client, O: AnyObject + Object<Ctx>,

Remove all objects from the store. MUST be called before the store is dropped, to ensure on_disconnect is called for all objects.

Trait Implementations

impl<Object: Debug> Debug for Store<Object>

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

Formats the value using the given formatter.

impl<Object> Default for Store<Object>

fn default() -> Self

Returns the “default value” for a type.

impl<Object> Drop for Store<Object>

fn drop(&mut self)

Executes the destructor for this type.

impl<O: AnyObject> EventSource<StoreUpdate> for Store<O>

type Source = impl Stream<Item = StoreUpdate> + 'static

Type of event stream you get from this event source.

fn subscribe(&self) -> Self::Source

Get a stream of events from the event source.

impl<O: AnyObject> Store<O> for Store<O>

type ByType<'a, T> where O: 'a, T: MonoObject + 'a = impl Iterator<Item = (u32, &'a T)> + 'a

Type of iterator returned by by_type

type IdsByType<'a, T> where O: 'a, T: 'static = impl Iterator<Item = u32> + 'a

Type of iterator returned by ids_by_type_mut

fn insert<T: Into<O> + 'static>( &mut self, object_id: u32, object: T ) -> Result<&mut T, T>

Insert object into the store with the given ID. Returns a unique reference to the inserted object if successful, Err(T) if the ID is already in use.

fn insert_with_state<T: Into<O> + MonoObject + 'static>( &mut self, object_id: u32, object: T ) -> Result<(&mut T, &mut T::SingletonState), T>

Insert object into the store with the given ID. Returns a unique reference to the inserted object and its singleton state if successful, Err(T) if the ID is already in use.

fn allocate<T: Into<O> + 'static>( &mut self, object: T ) -> Result<(u32, &mut T), T>

Allocate a new ID for the client, associate object for it. This is for inserting server allocated objects. According to the wayland spec, the ID must start from 0xff000000

fn remove(&mut self, object_id: u32) -> Option<O>

Remove an object from the store. Returns the removed object if it is found.

fn get_state<T: MonoObject>(&self) -> Option<&T::SingletonState>

Returns the singleton state associated with an object type. Returns None if no object of that type is in the store, or if the object type does not have a singleton state.

fn get_state_mut<T: MonoObject>(&mut self) -> Option<&mut T::SingletonState>

See Store::get_state

fn get_with_state<T: MonoObject>( &self, id: u32 ) -> Result<(&T, &T::SingletonState), GetError>

Get a reference an object with its associated singleton state

fn get_with_state_mut<'a, T: MonoObject>( &'a mut self, id: u32 ) -> Result<(&'a mut T, &'a mut T::SingletonState), GetError>

Get a unique reference to an object with its associated singleton state

fn get<T: 'static>(&self, object_id: u32) -> Result<&T, GetError>

Get a reference to an object from the store, and cast it down to the concrete type.

fn get_mut<T: 'static>(&mut self, id: u32) -> Result<&mut T, GetError>

Get a unique reference to an object from the store, and cast it down to the concrete type.

fn contains(&self, id: u32) -> bool

Returns whether the store contains a given ID

fn try_insert_with(&mut self, id: u32, f: impl FnOnce() -> O) -> Option<&mut O>

Try to insert an object into the store with the given ID, the object is created by calling the closure f. f is never called if the ID already exists in the store.

fn try_insert_with_state<T: Into<O> + MonoObject + 'static>( &mut self, id: u32, f: impl FnOnce(&mut T::SingletonState) -> T ) -> Option<(&mut T, &mut T::SingletonState)>

Try to insert an object into the store with the given ID, the object is created by calling the closure f with the singleton state that’s associated with the object type. f is never called if the ID already exists in the store.

fn by_type<T: MonoObject>(&self) -> Self::ByType<'_, T>

Returns an iterator for all objects in the store with a specific type.

fn ids_by_type<T: 'static>(&self) -> Self::IdsByType<'_, T>

Returns an iterator that yields all the object IDs for objects in the store with a specific type.