Struct Path 

pub struct Path<R, T> { /* private fields */ }

The location of a T inside the record R. See the module docs.

Implementations

impl<R, T, S> Path<R, Items<T, S>>

where T: Model + Identified,

pub fn item(&self, id: &Id) -> <T as Model>::Paths<R>

The item id, its own paths rooted here.

pub fn item_path(&self, id: &Id) -> Path<R, T>

The path of the item id itself.

pub fn remove(&self, id: &Id) -> Edit<R>

Remove the item id.

impl<R, T> Path<R, Items<T, ById>>

where T: Model + Identified,

pub fn upsert(&self, before: Option<&T>, after: &T) -> Vec<Edit<R>>

The edits that make the item after what it is: added when before is None, else changed field by field from before.

pub fn insert(&self, item: &T) -> Edit<R>

Add item under its own id.

impl<R, T> Path<R, Items<T, Arranged>>

where T: Model + Identified,

pub fn insert(&self, at: usize, item: &T) -> Edit<R>

Add item under its own id at position at.

pub fn move_to(&self, id: &Id, at: usize) -> Edit<R>

Move the item id to position at.

impl<R> Path<R, R>

pub const fn root() -> Path<R, R>

The record itself.

impl<R, T> Path<R, T>

where R: Model,

pub fn object(&self, doc: &AutoCommit) -> Option<ExId>

The object the value at this path is stored in — a record’s map, a list, a text — resolved through each container’s own layout, for an editor that binds to the object itself (a rich-text field inside a collection item); None when absent or stored as a scalar.

impl<R, T> Path<R, T>

pub fn from_segments(segments: Vec<Segment>) -> Path<R, T>

A path from stored segments. A path read back from storage or the wire is checked when an edit at it applies.

pub fn segments(&self) -> &[Segment]

pub fn into_segments(self) -> Vec<Segment>

pub fn under<P>(&self, prefix: &Path<P, R>) -> Path<P, T>

This path, rooted at an item, seen from the record containing it: a row’s favorite as Snippets › snippets › <id> › favorite.

pub fn get<'a>(&self, root: &'a R) -> Option<&'a T>

where R: Model + 'static, T: 'static,

The value at this path in root, if it is there.

pub fn starts_with<U>(&self, other: &Path<R, U>) -> bool

Whether self is other or lies inside it.

pub fn edits(&self, before: &T, after: &T) -> Vec<Edit<R>>

where T: Model,

The field edits that turn before, the value at this path, into after: what a surface that edited a local copy submits, field by field and item by item (Model::diff).

pub fn edit(&self, op: EditOp) -> Edit<R>

The edit op at this path.

impl<R, T> Path<R, T>

where T: Settable,

pub fn set(&self, value: T) -> Edit<R>

Replace the value.

impl<R, T> Path<R, T>

where T: Operations,

pub fn perform(&self, op: &<T as Operations>::Op) -> Result<Edit<R>, Error>

The edit op of the value at this path, in the type’s own vocabulary.

Errors

Returns the serialization error of op.

impl<R, T> Path<R, Option<T>>

where T: Model,

pub fn some(&self) -> <T as Model>::Paths<R>

The value when present; edits at it refuse while it is absent.

impl<R> Path<R, String>

pub fn splice( &self, at: usize, delete: usize, insert: impl Into<String>, ) -> Edit<R>

Replace delete characters at at with insert.

pub fn replace(&self, text: impl Into<String>) -> Edit<R>

Replace the whole text, written as the smallest splice that turns the stored text into it.

impl<R> Path<R, Counter>

pub fn add(&self, by: i64) -> Edit<R>

Add by (negative to subtract). Concurrent additions add up.

impl<R, T> Path<R, Set<T>>

where T: Model,

pub fn insert(&self, value: &T) -> Edit<R>

Add an element.

pub fn remove(&self, value: &T) -> Edit<R>

Remove an element.

impl<R, T> Path<R, Collection<T>>

where T: Model,

pub fn item(&self, id: &Id) -> <T as Model>::Paths<R>

The item id, its own paths rooted here.

pub fn item_path(&self, id: &Id) -> Path<R, T>

The path of the item id itself.

pub fn insert(&self, at: usize, value: &T) -> Edit<R>

Insert value at at (clamped to the end) under a fresh id minted when the edit applies.

pub fn insert_as(&self, id: &Id, at: usize, value: &T) -> Edit<R>

Insert value at at (clamped to the end) under id.

pub fn remove(&self, id: &Id) -> Edit<R>

Remove the item id.

pub fn move_to(&self, id: &Id, at: usize) -> Edit<R>

Move the item id to at (clamped to the end).

impl<R, T> Path<R, BTreeMap<String, T>>

where T: Model,

pub fn key(&self, key: impl Into<String>) -> <T as Model>::Paths<R>

The entry key, its own paths rooted here.

pub fn remove(&self, key: impl Into<String>) -> Edit<R>

Remove the entry key.

impl<R, T> Path<R, Grid<T>>

where T: Model,

pub fn cell(&self, row: &Id, column: &Id) -> <T as Model>::Paths<R>

The cell at row, column, its own paths rooted here.

pub fn set_cell(&self, row: &Id, column: &Id, value: Option<&T>) -> Edit<R>

Set or clear one cell.

pub fn insert_row(&self, at: usize) -> Edit<R>

Insert a row at at (clamped) under a fresh id minted when the edit applies.

pub fn insert_column(&self, at: usize) -> Edit<R>

Insert a column at at (clamped) under a fresh id.

pub fn remove_row(&self, row: &Id) -> Edit<R>

Remove a row and its cells.

pub fn remove_column(&self, column: &Id) -> Edit<R>

Remove a column and its cells.

impl<R, T, O> Path<R, Outbox<T, O>>

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

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

Record how the owning device settled the entry id: content from outside, nobody’s undo step.

pub fn forget(&self, id: &Id) -> Edit<R>

Forget the settled entry id: housekeeping, nobody’s undo step.

Trait Implementations

impl<R, T> Clone for Path<R, T>

fn clone(&self) -> Path<R, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R, T> Debug for Path<R, T>

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

Formats the value using the given formatter.

impl<'de, R, T> Deserialize<'de> for Path<R, T>

fn deserialize<D>( deserializer: D, ) -> Result<Path<R, T>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<R, T> Hash for Path<R, T>

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<R, T> Ord for Path<R, T>

fn cmp(&self, other: &Path<R, T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<R, T> PartialEq for Path<R, T>

fn eq(&self, other: &Path<R, T>) -> 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.

impl<R, T> PartialOrd for Path<R, T>

fn partial_cmp(&self, other: &Path<R, T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<R, T> Serialize for Path<R, T>

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<R, T> Eq for Path<R, T>