Struct DocumentBuilder

Source

pub struct DocumentBuilder(/* private fields */);

Expand description

A struct for building documents from a collection of operations.

Implementations§

Source §

impl DocumentBuilder

Source

pub fn new(operations: Vec<(OperationId, Operation, PublicKey)>) -> Self

Instantiate a new DocumentBuilder from a collection of operations.

Source

pub fn operations(&self) -> &Vec<(OperationId, Operation, PublicKey)>

Get all unsorted operations for this document.

Source

pub fn build( &self, ) -> Result<(Document, Vec<(OperationId, Operation, PublicKey)>), DocumentBuilderError>

Validates all contained operations and builds the document.

The returned document contains the latest resolved [document view][DocumentView].

Validation checks the following:

There is exactly one CREATE operation.
All operations are causally connected to the root operation.
All operations follow the same schema.
No cycles exist in the graph.

Source

pub fn build_to_view_id( &self, document_view_id: DocumentViewId, ) -> Result<(Document, Vec<(OperationId, Operation, PublicKey)>), DocumentBuilderError>

Validates all contained operations and builds the document up to the requested DocumentViewId.

The returned document contains the requested [document view][DocumentView].

Validation checks the following:

There is exactly one CREATE operation.
All operations are causally connected to the root operation.
All operations follow the same schema.
No cycles exist in the graph.

Trait Implementations§

Source §

impl Clone for DocumentBuilder

Source §

fn clone(&self) -> DocumentBuilder

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for DocumentBuilder

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<T> From<&Vec<T>> for DocumentBuilder
where T: AsOperation + WithId<OperationId> + WithPublicKey,

Source §

fn from(operations: &Vec<T>) -> Self

Converts to this type from the input type.

Source §

impl<T> From<Vec<&T>> for DocumentBuilder
where T: AsOperation + WithId<OperationId> + WithPublicKey,

Source §

fn from(operations: Vec<&T>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl UnwindSafe for DocumentBuilder

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more

Source §