Trait Model

pub trait Model: Sized + 'static {
    type Paths<R>: Clone;

    const SHAPE: Shape = crate::Shape::Value;
    const CHECKS: bool = false;
    const OPS: bool = false;
    const NULLABLE: bool = false;
    const SCALAR: bool = false;
    const TABLE: &'static ModelTable = _;
Show 24 methods
    // Required methods
    fn paths_at<R>(path: Path<R, Self>) -> Self::Paths<R>;
    fn to_json(&self) -> Value;
    fn from_json(value: &Value) -> Result<Self, ModelError>;
    fn load(
        doc: &AutoCommit,
        value: &Value<'_>,
        id: &ExId,
    ) -> Result<Self, ModelError>;
    fn store(
        &self,
        doc: &mut AutoCommit,
        slot: Slot<'_>,
    ) -> Result<(), ModelError>;

    // Provided methods
    fn edit(
        doc: &mut AutoCommit,
        slot: Slot<'_>,
        path: &[Segment],
        op: &EditOp,
        cx: &mut ActionCx,
    ) -> Result<(), ModelError> { ... }
    fn diff<R>(&self, after: &Self, path: &[Segment], out: &mut Vec<Edit<R>>) { ... }
    fn nested_collections(&self) -> Vec<ItemCollection> { ... }
    fn value_schema() -> Value { ... }
    fn field_type(types: &mut TypeSet) -> FieldType { ... }
    fn read_whole(&mut self, doc: &AutoCommit) -> Result<(), ModelError> { ... }
    fn check(&self) -> Result<(), Refusal> { ... }
    fn label(&self) -> Option<String> { ... }
    fn op_coalesces(
        path: &[Segment],
        previous: &Value,
        next: &Value,
    ) -> Option<bool> { ... }
    fn op_continuable(path: &[Segment], op: &Value) -> Option<bool> { ... }
    fn op_describe(path: &[Segment], op: &Value) -> Option<OpDescription> { ... }
    fn op_lands(&self, path: &[Segment], op: &Value) -> Option<Place> { ... }
    fn op_schemas(prefix: &str, out: &mut Vec<(String, Value)>) { ... }
    fn get_at(&self, path: &[Segment]) -> Option<&(dyn Any + 'static)>
       where Self: 'static { ... }
    fn missing() -> Result<Self, ModelError> { ... }
    fn stores_as(&self, before: &Self) -> bool { ... }
    fn store_changed(
        &self,
        before: &Self,
        doc: &mut AutoCommit,
        slot: Slot<'_>,
        dirty: &Delta,
    ) -> Result<(), ModelError> { ... }
    fn refresh(
        &mut self,
        doc: &AutoCommit,
        value: &Value<'_>,
        id: &ExId,
        delta: &Delta,
    ) -> Result<(), ModelError> { ... }
    fn collect_text(&self, _out: &mut Vec<String>) { ... }
}

Expand description

A typed value stored in a CRDT document. See the module docs.

Provided Associated Constants§

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

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

const CHECKS: bool = false

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

const OPS: bool = false

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.

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.

Required Associated Types§

type Paths<R>: Clone

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.

Required Methods§

fn paths_at<R>(path: Path<R, Self>) -> Self::Paths<R>

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<Self, ModelError>

A value from its Self::to_json form.

§Errors

Returns [ModelError] when value has another shape.

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

Read from the value a parent found in its slot.

§Errors

Returns [ModelError] when the stored value has another shape.

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

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

Provided Methods§

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

Apply the field edit op at path, below the value in slot, touching only what it changes, then run the invariants of the values it touched. The default edits a value only as a whole.

fn diff<R>(&self, after: &Self, 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. A value that would store as it is (Self::stores_as) is compared in memory, without turning either side into JSON.

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 field_type(types: &mut TypeSet) -> FieldType

This value’s type in the language-neutral vocabulary a surface publishes (FieldType), declaring the records and enums it names in types. The default describes no type: 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.

§Errors

Returns [ModelError] when the document no longer holds the value.

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

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

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 store(&self, _: &mut AutoCommit, _: Slot<'_>) -> Result<(), ModelError>

Nothing is written: an absent slot reads as () already.

The one splice store makes, found from before instead of reading the whole text back.

impl<T, const KEEP: usize> Model for Recents<T, KEEP>
where T: Serialize + DeserializeOwned + 'static,

Stored as one JSON value, written whole.

§

Trait Model Copy item path

Provided Associated Constants§

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

const CHECKS: bool = false

const OPS: bool = false

const NULLABLE: bool = false

const SCALAR: bool = false

const TABLE: &'static ModelTable = _

Required Associated Types§

type Paths<R>: Clone

Required Methods§

fn paths_at<R>(path: Path<R, Self>) -> Self::Paths<R>

fn to_json(&self) -> Value

fn from_json(value: &Value) -> Result<Self, ModelError>

§Errors

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

§Errors

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

Provided Methods§

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

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

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

fn value_schema() -> Value

fn field_type(types: &mut TypeSet) -> FieldType

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

§Errors

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

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

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

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

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

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

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

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

fn missing() -> Result<Self, ModelError>

§Errors

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

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

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

§Errors

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

Dyn Compatibility§

Implementations on Foreign Types§

impl Model for bool

const SCALAR: bool = true

const TABLE: &'static ModelTable

type Paths<R> = Path<R, bool>

fn value_schema() -> Value

fn field_type(types: &mut TypeSet) -> FieldType

fn paths_at<R>(path: Path<R, bool>) -> Path<R, bool>

fn to_json(&self) -> Value

fn from_json(value: &Value) -> Result<bool, ModelError>

fn load(_: &AutoCommit, value: &Value<'_>, _: &ExId) -> Result<bool, ModelError>

fn missing() -> Result<bool, ModelError>

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

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

impl Model for f32

const SCALAR: bool = true

const TABLE: &'static ModelTable

type Paths<R> = Path<R, f32>

fn value_schema() -> Value

fn field_type(types: &mut TypeSet) -> FieldType

fn paths_at<R>(path: Path<R, f32>) -> Path<R, f32>

fn to_json(&self) -> Value

fn from_json(value: &Value) -> Result<f32, ModelError>

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

fn missing() -> Result<f32, ModelError>

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

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

impl Model for f64

const SCALAR: bool = true

const TABLE: &'static ModelTable

type Paths<R> = Path<R, f64>

fn value_schema() -> Value

fn field_type(types: &mut TypeSet) -> FieldType

fn paths_at<R>(path: Path<R, f64>) -> Path<R, f64>

fn to_json(&self) -> Value

fn from_json(value: &Value) -> Result<f64, ModelError>

fn load(_: &AutoCommit, value: &Value<'_>, _: &ExId) -> Result<f64, ModelError>

fn missing() -> Result<f64, ModelError>

Trait Model

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