Struct Document 

pub struct Document { /* private fields */ }

High-level datatype representing data published to the p2panda network as key-value pairs.

Documents are multi-writer and have automatic conflict resolution strategies which produce deterministic state for any two replicas. The underlying structure which make this possible is a directed acyclic graph of Operation’s. To arrive at the current state of a document the graph is topologically sorted, with any branches being ordered according to the conflicting operations OperationId. Each operation’s mutation is applied in order which results in a LWW (last write wins) resolution strategy.

All documents have an accompanying Schema which describes the shape of the data they will contain. Every operation should have been validated against this schema before being included in the graph.

Documents are constructed through the DocumentBuilder or by conversion from vectors of a type implementing the AsOperation, WithId<OperationId> and WithPublicKey.

To efficiently commit more operations to an already constructed document use the commit method. Any operations committed in this way must refer to the documents current view id in their previous field.

See module docs for example uses.

Trait Implementations

impl AsDocument for Document

fn id(&self) -> &DocumentId

Get the document id.

fn view_id(&self) -> &DocumentViewId

Get the document view id.

fn author(&self) -> &PublicKey

Get the document author’s public key.

fn schema_id(&self) -> &SchemaId

Get the document schema.

fn fields(&self) -> Option<&DocumentViewFields>

Get the fields of this document.

fn update_view( &mut self, id: &DocumentViewId, view: Option<&DocumentViewFields>, )

Update the current view of this document.

fn is_edited(&self) -> bool

Returns true if this document has applied an UPDATE operation.

fn is_deleted(&self) -> bool

Returns true if this document has processed a DELETE operation.

fn view(&self) -> Option<DocumentView>

The current document view for this document. Returns None if this document has been deleted.

fn get(&self, key: &str) -> Option<&OperationValue>

Get the value for a field on this document.

fn commit<T: AsOperation>( &mut self, operation_id: &OperationId, operation: &T, ) -> Result<(), DocumentError>

Update a documents current view with a single operation.

fn commit_unchecked<T: AsOperation>( &mut self, operation_id: &OperationId, operation: &T, )

Commit an new operation to the document without performing any validation.

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Display for Document

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

Formats the value using the given formatter.

impl Human for Document

fn display(&self) -> String

Returns a shorter representation of the type.

impl<T> TryFrom<&Vec<T>> for Document

where T: AsOperation + WithId<OperationId> + WithPublicKey,

type Error = DocumentBuilderError

The type returned in the event of a conversion error.

fn try_from(operations: &Vec<T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<Vec<&T>> for Document

where T: AsOperation + WithId<OperationId> + WithPublicKey,

type Error = DocumentBuilderError

The type returned in the event of a conversion error.

fn try_from(operations: Vec<&T>) -> Result<Self, Self::Error>

Performs the conversion.