Struct Lineage 

pub struct Lineage {
    pub parent: Option<DocumentId>,
    pub ancestors: Vec<DocumentId>,
    pub version: Option<u32>,
    pub depth: Option<u32>,
    pub branch: Option<String>,
    pub merged_from: Vec<DocumentId>,
    pub note: Option<String>,
}

Version history and document relationships.

Fields

parent: Option<DocumentId>

Document ID of parent version.

ancestors: Vec<DocumentId>

Up to 10 levels of ancestors for efficient chain verification. Ordered from nearest (parent’s parent) to furthest ancestor.

version: Option<u32>

Sequential version number.

depth: Option<u32>

Distance from the root document (0 for root, 1 for first child, etc.).

branch: Option<String>

Branch identifier.

merged_from: Vec<DocumentId>

Document IDs of documents merged into this version.

note: Option<String>

Description of changes.

Implementations

impl Lineage

pub fn root() -> Self

Create a new root lineage (first version of a document).

pub fn from_parent( parent_id: DocumentId, parent_lineage: Option<&Lineage>, ) -> Self

Create lineage that derives from a parent document.

This automatically computes the ancestor chain (up to 10 levels) and increments the depth.

pub fn with_note(self, note: impl Into<String>) -> Self

Add a note describing the changes in this version.

pub fn with_branch(self, branch: impl Into<String>) -> Self

Set the branch name.

pub fn with_merge(self, merged_id: DocumentId) -> Self

Record that this version was created by merging another document.

Trait Implementations

impl Clone for Lineage

fn clone(&self) -> Lineage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Lineage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Lineage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Lineage

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Lineage

impl StructuralPartialEq for Lineage