Struct Edit 

pub struct Edit<R> { /* private fields */ }

A field edit of the record R: a path and an operation. See the module docs.

Implementations

impl<R> Edit<R>

pub fn new(path: Vec<Segment>, op: EditOp) -> Edit<R>

An edit from its parts, as read back from the wire.

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

pub fn op(&self) -> &EditOp

pub fn retyped<S>(self) -> Edit<S>

The same edit, of the record S: the path and operation it carries do not depend on the record type.

pub fn from_json(value: Value) -> Result<Edit<R>, String>

The edit in value, its JSON form.

Errors

Why value is no field edit.

pub fn coalesces(&self, next: &Edit<R>) -> bool

where R: Model,

Whether next, by the same actor straight after self, continues the same gesture: one undo step. Setting one path again (dragging a slider) and typing on at the end of the previous splice (a word) continue; an edit in a type’s own vocabulary continues as that type says ([Operations::coalesces]); anything else starts a new step.

pub fn risk(&self) -> RiskLevel

where R: Model,

How much harm this edit can do: removing an item of a collection is destructive, like a delete verb, unless the collection is #[model(remove = "quiet")]; every other edit is low.

pub fn tree_path(&self, room: &str, app: &str, record: &str) -> TreePath

where R: Resource,

The node of the published tree this edit acts on, for deciding grants: room › app › kind › record [› item] › field… › field-edit. The collection field holding an item is not a node of its own.

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

where R: Fields,

Apply to a document held apart from any resource (a form’s local value): no action, no history, ids minted from the document alone.

Errors

As Self::apply.

pub fn apply( &self, doc: &mut AutoCommit, cx: &mut ActionCx, ) -> Result<(), ModelError>

where R: Fields,

Apply at its path in doc, then run the invariants of every value the edit touched.

Errors

Returns why the path or operation does not fit the model, or the refusal of a check.

Trait Implementations

impl<R> Clone for Edit<R>

fn clone(&self) -> Edit<R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R> Debug for Edit<R>

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

Formats the value using the given formatter.

impl<'de, R> Deserialize<'de> for Edit<R>

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<R> From<&Edit<R>> for Invoke<R>

where R: Resource,

fn from(edit: &Edit<R>) -> Invoke<R>

Converts to this type from the input type.

impl<R> From<Edit<R>> for Invoke<R>

where R: Resource,

fn from(edit: Edit<R>) -> Invoke<R>

Converts to this type from the input type.

impl<R> JsonSchema for Edit<R>

fn json_schema() -> Value

The schema of this type’s JSON form.

const OPTIONAL: bool = false

Whether serde reads an absent field of this type as its default, as it does for Option: such a field is not required.

impl<R> PartialEq for Edit<R>

fn eq(&self, other: &Edit<R>) -> 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> Serialize for Edit<R>

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: Resource> Submit<R> for Edit<R>

fn action_id(&self) -> &'static str

The public id of the action this submits.

fn into_invoke(self) -> Result<Invoke<R>, String>

The invocation of the host door this submits.

fn control_binding(self, actions: &Actions<R>) -> Option<ActionBinding<()>>

The binding of a button that submits this when pressed, or None (and a failure in tests) when the resource does not publish it.