Struct Digest 

pub struct Digest { /* private fields */ }

A digest of one document.

prose is present only when a model wrote one, and carries suspect with it for as long as it exists. There is no method that clears the flag: a summary does not stop being a summary by being read twice.

Implementations

impl Digest

pub fn structural(source: B3Hash, origin: Option<Locator>, text: &str) -> Digest

The mechanical digest: structure only, and nothing to distrust.

pub fn with_prose(self, prose: String) -> Digest

Adds the prose a model wrote. It is suspect from here on, which is why this consumes and returns rather than mutating in place: the value that carries prose is a different value.

pub fn source(&self) -> B3Hash

pub fn origin(&self) -> Option<&Locator>

pub fn structure(&self) -> &[StructureNode]

pub fn prose(&self) -> Option<&str>

pub fn is_suspect(&self) -> bool

True while any part of this digest was written rather than read.

pub fn window_header(&self) -> String

How a digest introduces itself in a window. A suspect digest says so and says where the source is, so the reader can go and check rather than believing a paraphrase.

Trait Implementations

impl Clone for Digest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Digest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Digest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Digest

impl PartialEq for Digest

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Digest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Digest