Struct biodivine_sketchbook::app::state::AppState

source ·
pub struct AppState {
    session_state: Mutex<HashMap<String, DynSession>>,
    window_to_session: Mutex<HashMap<String, String>>,
}
Expand description

AppState implements mapping between session IDs and session objects.

Specifically, it ensures:

  • Synchronization by locking the app state.
  • Ability to add/remove windows as they are opened/closed.
  • Error handling and retransmission of events.

As such, AppState does not actually implement the super::SessionState trait.

Fields§

§session_state: Mutex<HashMap<String, DynSession>>§window_to_session: Mutex<HashMap<String, String>>

Implementations§

source§

impl AppState

source

pub fn session_created(&self, id: &str, session: impl Into<DynSession>)

Register the newly created session to the AppState.

source

pub fn window_created(&self, id: &str, session_id: &str)

Register the newly created window to the corresponding session in the AppState.

source

pub fn get_session_id(&self, window: &Window) -> String

Get the ID of the session that owns given Window.

source

pub fn get_windows_for_session(&self, session_id: &str) -> Vec<String>

Get IDs of all windows corresponding to a given session.

source

pub fn emit_to_session_windows( &self, app: &AeonApp, session_id: &str, state_change: StateChange, ) -> Result<(), DynError>

Emit state change events to all front-end windows corresponding to a given session.

source

pub fn consume_event( &self, app: &AeonApp, session_id: &str, action: &UserAction, ) -> Result<(), DynError>

source

pub fn consume_message( &self, app: &AeonApp, session_to_id: &str, session_from_id: &str, message: &SessionMessage, ) -> Result<(), DynError>

source

pub fn refresh( &self, app: &AeonApp, session_id: &str, full_path: &[String], ) -> Result<(), DynError>

Trait Implementations§

source§

impl Default for AppState

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

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

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

source§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

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

§

fn vzip(self) -> V

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T