Struct agde_io::StateHandle

pub struct StateHandle<P: Platform> {
    pub manager: Arc<Mutex<Manager>>,
    pub options: Arc<Options<P>>,
    pub platform: PlatformExt<P>,
    /* private fields */
}

Fields

manager: Arc<Mutex<Manager>>

options: Arc<Options<P>>

platform: PlatformExt<P>

Implementations

impl<P: Platform> StateHandle<P>

pub async fn commit_and_send( &self, cursors: &mut [Cursor<'_>] ) -> Result<(), ApplicationError>

Commit and send our changes. This also pulls the changes from others to the current storage.

The cursors are a list of byte-index positions in the resources where you have cursors (read: text-editing cursors). After calling this function, their Cursor::index are modified according to the changes from your piers. This means your user’s cursor changes position when pulling changes, to the logically same place, even if edits happened above in the document.

pub fn abort_tasks(&self)

Abort all running tasks set up by agde.

This disabled listening for new messages, committing our changes, resolving the fast forward, and periodic events such as flushing and log checks.

Use this when implementing shutdown.

Trait Implementations

impl<P: Clone + Platform> Clone for StateHandle<P>

fn clone(&self) -> StateHandle<P>

Returns a copy of the value.

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

Performs copy-assignment from source.