pub struct Atom {
pub id: AtomId,
pub ops: Vec<TextOp>,
pub parents: Vec<AtomId>,
pub provenance: Provenance,
pub signature: AtomSignature,
pub inverse_of: Option<AtomId>,
}Expand description
The core flow primitive.
id is derived from the rest of the content; constructors and decoders
recompute and validate it. Two atoms that encode the same ops, parents,
provenance, and inverse_of always have the same id, regardless of which
encoding they were materialized from.
Fields§
§id: AtomId§ops: Vec<TextOp>§parents: Vec<AtomId>§provenance: Provenance§signature: AtomSignature§inverse_of: Option<AtomId>Implementations§
Source§impl Atom
impl Atom
Sourcepub fn sign(
ops: Vec<TextOp>,
parents: Vec<AtomId>,
provenance: Provenance,
inverse_of: Option<AtomId>,
principal_key: &SigningKey,
persona_key: &SigningKey,
) -> Result<Self, AtomError>
pub fn sign( ops: Vec<TextOp>, parents: Vec<AtomId>, provenance: Provenance, inverse_of: Option<AtomId>, principal_key: &SigningKey, persona_key: &SigningKey, ) -> Result<Self, AtomError>
Sign and assemble an atom from its content.
Steps: encode the body canonically, derive AtomId as SHA-256(body),
sign that 32-byte id with both keys, return the assembled atom.
Sourcepub fn invert(
target: &Atom,
provenance: Provenance,
principal_key: &SigningKey,
persona_key: &SigningKey,
) -> Result<Self, AtomError>
pub fn invert( target: &Atom, provenance: Provenance, principal_key: &SigningKey, persona_key: &SigningKey, ) -> Result<Self, AtomError>
Build the inverse of target. The new atom’s ops are the reverse
list of target.ops, each individually inverted, with inverse_of
pointing at target.id. Useful for “undo” — the user-facing model
stacks an inverse atom rather than mutating history.
Sourcepub fn verify_content_hash(&self) -> Result<(), AtomError>
pub fn verify_content_hash(&self) -> Result<(), AtomError>
Recompute id from the body and check that it matches the stored
id. Returns Err(ContentHashMismatch) on drift.
Sourcepub fn verify_signatures(&self) -> Result<(), AtomError>
pub fn verify_signatures(&self) -> Result<(), AtomError>
Verify both signatures against the atom’s id. Does not consult the trust graph — that’s the caller’s responsibility (the trust graph decides whether the keys themselves are currently trusted).
Sourcepub fn verify(&self) -> Result<(), AtomError>
pub fn verify(&self) -> Result<(), AtomError>
Combined verify_content_hash + verify_signatures. Most callers
want this.
Sourcepub fn apply(&self, document: &mut Vec<u8>) -> Result<(), AtomError>
pub fn apply(&self, document: &mut Vec<u8>) -> Result<(), AtomError>
Apply this atom’s ops to document in order. Returns Err if any
op fails (offset out of range or Delete content mismatch).
Sourcepub fn to_json(&self) -> Result<String, AtomError>
pub fn to_json(&self) -> Result<String, AtomError>
Encode as JSON. Round-trips with Atom::from_json_slice.
Sourcepub fn from_json_slice(bytes: &[u8]) -> Result<Self, AtomError>
pub fn from_json_slice(bytes: &[u8]) -> Result<Self, AtomError>
Decode from JSON, then verify the content hash (not signatures).
Sourcepub fn to_binary(&self) -> Result<Vec<u8>, AtomError>
pub fn to_binary(&self) -> Result<Vec<u8>, AtomError>
Encode as canonical binary bytes. Round-trips with
Atom::from_binary_slice and is byte-stable across processes.
Sourcepub fn from_binary_slice(bytes: &[u8]) -> Result<Self, AtomError>
pub fn from_binary_slice(bytes: &[u8]) -> Result<Self, AtomError>
Decode from canonical binary bytes, then verify the content hash (not signatures).
Trait Implementations§
Source§impl<'de> Deserialize<'de> for Atom
impl<'de> Deserialize<'de> for Atom
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
impl Eq for Atom
impl StructuralPartialEq for Atom
Auto Trait Implementations§
impl Freeze for Atom
impl RefUnwindSafe for Atom
impl Send for Atom
impl Sync for Atom
impl Unpin for Atom
impl UnsafeUnpin for Atom
impl UnwindSafe for Atom
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);