Struct Outbox 

pub struct Outbox<T, O = ()> { /* private fields */ }

Outside consequences of the record’s actions, queued in the document: a mail to send, an event to upload, a file to move. A verb that takes &mut Outbox<T, O> pushes entries and is an Outside action.

Every replica replays the entries; only the device that owns an entry carries it out. The framework drains the outbox there, runs the app’s handler for each pending entry and records how it settled, with the handler’s result O, through the settle edit: content from outside, nobody’s undo step. A verb reads a settlement with Self::outcome (a revert needs to know where the trashed file went), may settle an entry itself (Self::settle) and forgets settled entries (Self::forget, Self::prune).

Implementations

impl<T, O> Outbox<T, O>

pub fn new() -> Outbox<T, O>

pub fn push(&mut self, id: Id, value: T) -> Id

Queue value under id (mint it with ActionCx::id). Queued by an undo’s or a redo’s compensating action, it records the steps it settles.

pub fn pending(&self) -> impl Iterator<Item = (&Id, &T)>

The entries the owning device has yet to run, oldest first.

pub fn entries(&self) -> impl ExactSizeIterator

Every entry, settled or not, oldest first.

pub fn get(&self, id: &Id) -> Option<&OutboxEntry<T, O>>

pub fn outcome(&self, id: &Id) -> Option<&Settled<O>>

How the entry id settled; None while it is pending or when there is no such entry.

pub fn settle(&mut self, id: &Id, outcome: Settled<O>) -> bool

Record how the entry id settled, from a verb. Whether there is such an entry.

pub fn forget(&mut self, id: &Id) -> Option<OutboxEntry<T, O>>

Forget the entry id. A pending entry forgotten is never carried out.

pub fn prune(&mut self, keep: usize)

Forget the oldest settled entries beyond the newest keep; pending ones stay.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

Trait Implementations

impl<T, O> Clone for Outbox<T, O>

where T: Clone, O: Clone,

fn clone(&self) -> Outbox<T, O>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, O> Debug for Outbox<T, O>

where T: Debug, O: Debug,

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

Formats the value using the given formatter.

impl<T, O> Default for Outbox<T, O>

fn default() -> Outbox<T, O>

Returns the “default value” for a type.

impl<T, O> Model for Outbox<T, O>

where T: Model, O: Serialize + DeserializeOwned + Default + 'static,

fn edit( doc: &mut AutoCommit, slot: Slot<'_>, path: &[Segment], op: &EditOp, _cx: &mut ActionCx, ) -> Result<(), ModelError>

Entries are queued by verbs; an edit settles one or forgets a settled one.

const CHECKS: bool = T::CHECKS

Whether this type or any value inside it has a #[model(check)] invariant; Self::check has nothing to do otherwise.

const OPS: bool = T::OPS

Whether this type or a value inside it has a vocabulary of its own (Operations, rich text’s): a record routes those edits’ gestures, landing places and schemas only into such fields, and never instantiates the routing for the others.

type Paths<R> = Path<R, Outbox<T, O>>

The typed paths into a value of this type, rooted in the record R: a struct of field paths for a record, the Path itself for a value edited whole or through its own operations.

fn paths_at<R>(path: Path<R, Outbox<T, O>>) -> Path<R, Outbox<T, O>>

The paths of the value at path.

fn to_json(&self) -> Value

The value as JSON: what [EditOp::Set] carries and history shows.

fn from_json(value: &Value) -> Result<Outbox<T, O>, ModelError>

A value from its Self::to_json form.

fn load( doc: &AutoCommit, value: &Value<'_>, id: &ExId, ) -> Result<Outbox<T, O>, ModelError>

Read from the value a parent found in its slot.

fn missing() -> Result<Outbox<T, O>, ModelError>

The value of an absent slot. Types with a natural empty value return it, so a field added to a schema reads older documents without migration.

fn store(&self, doc: &mut AutoCommit, slot: Slot<'_>) -> Result<(), ModelError>

Write self into slot, changing only what differs from what the slot already holds.

fn refresh( &mut self, doc: &AutoCommit, value: &Value<'_>, id: &ExId, delta: &Delta, ) -> Result<(), ModelError>

Bring a value read earlier up to date after the changes in delta, re-reading only what they touched. value and id are what the parent’s slot holds now — the same object as when self was read, or the parent would have read it anew. The default reads the value again, which is right for scalars and short values.

fn check(&self) -> Result<(), Refusal>

Run every #[model(check)] invariant of this value and the values inside it.

fn diff<R>( &self, after: &Outbox<T, O>, path: &[Segment], out: &mut Vec<Edit<R>>, )

The field edits that turn self into after, at path below the record: what a surface that edited a local copy submits. The default sets the value whole when it changed; containers and records edit only what differs, item by item and field by field.

const SHAPE: Shape = crate::Shape::Value

How the value is laid out in the document; see Shape. Types written whole keep the default.

const NULLABLE: bool = false

Whether null is a value of the type: an absent Option. A field edit setting any other type to null is refused.

const SCALAR: bool = false

Whether store writes one scalar, with nothing inside it that a concurrent writer could add to. A record made just now leaves out such a field holding its missing value: an absent key reads as it. An object (text, a map, a list) is always made with its record, so two writers fill the same one.

const TABLE: &'static ModelTable = _

The type’s functions as data, which a record holding it reaches it through ([crate::table]): by default its own functions, erased.

fn nested_collections(&self) -> Vec<ItemCollection>

The item collections inside this value, when it is an item of a collection itself (a slide’s elements); #[derive(Model)] lists a record’s, the default has none.

fn value_schema() -> Value

The JSON Schema of this value’s JSON form (Self::to_json), as the published field edit describes what a path takes; the default accepts any value.

fn read_whole(&mut self, doc: &AutoCommit) -> Result<(), ModelError>

Read everything this value holds, for a field marked #[model(whole)]: a value read lazily (rich text reads its paragraphs as views ask for them) reads all of it, so every reader of the record — a verb, search, read_content — sees all of it. The default has nothing more to read.

fn label(&self) -> Option<String>

What names this value for people (#[model(label)]): history, search, agents and item resources use it.

fn op_coalesces( path: &[Segment], previous: &Value, next: &Value, ) -> Option<bool>

Whether two edits in the own vocabulary of the value at path below this type are one gesture (Operations); None when nothing there has one.

fn op_continuable(path: &[Segment], op: &Value) -> Option<bool>

Whether a gesture may go on after the edit op at path.

fn op_describe(path: &[Segment], op: &Value) -> Option<OpDescription>

What the edit op at path below this type did, in the history entry’s terms (Operations::describe).

fn op_lands(&self, path: &[Segment], op: &Value) -> Option<Place>

Where the actor of the edit op at path below this value is after it applied.

fn op_schemas(prefix: &str, out: &mut Vec<(String, Value)>)

The schemas of the own vocabularies of the values below this type, by path pattern from prefix (* for every item).

fn get_at(&self, path: &[Segment]) -> Option<&(dyn Any + 'static)>

where Self: 'static,

The value at path below this one, if it is there. A value with nothing inside it is found only at the empty path.

fn stores_as(&self, before: &Self) -> bool

Whether writing self over a slot that holds before, as a store left it, would change nothing: an in-memory comparison, so an action that changed one item of a long collection does not visit the others. Must only answer true when store would write no operation; the default answers false (unknown).

fn store_changed( &self, before: &Self, doc: &mut AutoCommit, slot: Slot<'_>, dirty: &Delta, ) -> Result<(), ModelError>

Write self into slot, which holds before: exactly the operations store would write, found by comparing with before where store would read the document.

fn collect_text(&self, _out: &mut Vec<String>)

Append the human-readable text this value carries, for search indexing.

impl<T, O> PartialEq for Outbox<T, O>

where T: PartialEq, O: PartialEq,

fn eq(&self, other: &Outbox<T, O>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.