agde_io

Struct StateHandle

source
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§

source§

impl<P: Platform> StateHandle<P>

source

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.

source

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§

source§

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

source§

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

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

Auto Trait Implementations§

§

impl<P> Freeze for StateHandle<P>
where P: Freeze,

§

impl<P> !RefUnwindSafe for StateHandle<P>

§

impl<P> Send for StateHandle<P>

§

impl<P> Sync for StateHandle<P>

§

impl<P> Unpin for StateHandle<P>
where P: Unpin,

§

impl<P> !UnwindSafe for StateHandle<P>

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> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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.

source§

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

source§

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<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