Skip to main content

TemplateStore

Struct TemplateStore 

Source
pub struct TemplateStore<T> {
    pub error: Option<String>,
    /* private fields */
}
Expand description

Named, host-readable templates. Without a storage service they live in memory. With a service attached, poll every frame, including while the template UI is closed. A failed read or an unknown document version disables writes until a successful reload, preventing accidental replacement of documents that could not be understood.

Fields§

§error: Option<String>

Last storage or document error. Failed saves retain the edited template in memory.

Implementations§

Source§

impl<T: Clone + Serialize + DeserializeOwned> TemplateStore<T>

Source

pub fn new(kind: StoreKind) -> Self

An empty catalog in the supplied namespace, initially kept only in memory.

Source

pub fn entries(&self) -> &BTreeMap<String, T>

Read the catalog, sorted by name, for a host-provided menu or export.

Source

pub fn ready(&self) -> bool

Whether saving, loading or deleting can begin. Reads must finish before writes start.

Source

pub fn set_storage(&mut self, storage: Arc<dyn Storage>)

Attach the host storage service and read its catalog. No document is written on attach.

Source

pub fn reload(&mut self)

Retry reading the catalog after a failed read. While a request is outstanding this does nothing, so reloading cannot race a write or discard an unsaved edit.

Source

pub fn poll(&mut self, ctx: &Context)

Receive storage answers and wake the UI when the next asynchronous answer arrives.

Source

pub fn save(&mut self, name: &str, template: T) -> Result<(), String>

Save or explicitly replace a named template. Blank names and concurrent writes are rejected.

Source

pub fn delete(&mut self, name: &str) -> Result<(), String>

Delete a named template. With storage attached the row remains until deletion succeeds.

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for TemplateStore<T>

§

impl<T> !UnwindSafe for TemplateStore<T>

§

impl<T> Freeze for TemplateStore<T>

§

impl<T> Send for TemplateStore<T>
where T: Send,

§

impl<T> Sync for TemplateStore<T>
where T: Sync,

§

impl<T> Unpin for TemplateStore<T>

§

impl<T> UnsafeUnpin for TemplateStore<T>

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> MaybeSend for T
where T: Send + Sync + ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

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.