Struct DocumentViewId 

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

The identifier of a document view.

Contains the operation ids of the document graph tips, which is all the information we need to reliably reconstruct a specific version of a document.

Document view ids are considered equal if they contain the same set of operation ids, independent of their order. Serialised document view ids always contain sorted operation ids and deserialisation of a value will fail if this does not hold. This follows p2panda’s requirement that all serialised arrays must be sorted and leads to deterministic serialisation.

The document with the following operation graph has the id "2fa.." and six different document
view ids, meaning that this document can be represented in six versions:

1. ["2fa"]
2. ["de8"]
3. ["89c"]
4. ["eff"]
5. ["de8", "eff"]
6. ["89c", "eff"]

[CREATE] (Hash: "2fa..") <-- [UPDATE] (Hash: "de8..") <-- [UPDATE] (Hash: "89c..")
                        \
                         \__ [UPDATE] (Hash: "eff..")

Implementations

impl DocumentViewId

pub fn new(graph_tips: &[OperationId]) -> Self

Create a new document view id.

The given operation ids will automatically be sorted and de-duplicated.

pub fn graph_tips(&self) -> &[OperationId]

Get the operation ids of this view id.

pub fn iter(&self) -> Iter<'_, OperationId>

Get the operation ids of this view id.

Trait Implementations

impl Clone for DocumentViewId

fn clone(&self) -> DocumentViewId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentViewId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentViewId

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DocumentViewId

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

Formats the value using the given formatter.

impl From<&DocumentViewId> for DocumentViewHash

fn from(document_view_id: &DocumentViewId) -> Self

Converts to this type from the input type.

impl From<DocumentViewId> for OperationValue

fn from(value: DocumentViewId) -> Self

Converts to this type from the input type.

impl From<DocumentViewId> for PlainValue

fn from(value: DocumentViewId) -> Self

Converts to this type from the input type.

impl From<DocumentViewId> for Vec<Hash>

fn from(value: DocumentViewId) -> Self

Converts to this type from the input type.

impl From<Hash> for DocumentViewId

Convenience method converting a single hash into a document view id.

Converts a Hash instance into a DocumentViewId, assuming that this document view only consists of one graph tip hash.

fn from(hash: Hash) -> Self

Converts to this type from the input type.

impl From<OperationId> for DocumentViewId

Convenience method converting a single OperationId into a document view id.

Converts an OperationId instance into a DocumentViewId, assuming that this document view only consists of one graph tip hash.

fn from(operation_id: OperationId) -> Self

Converts to this type from the input type.

impl FromStr for DocumentViewId

Convenience method converting a hash string into a document view id.

Converts a string formatted document view id into a DocumentViewId. Expects multi-hash ids to be hash strings separated by an _ character.

type Err = DocumentViewIdError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for DocumentViewId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Human for DocumentViewId

fn display(&self) -> String

Returns a shorter representation of the type.

impl Ord for DocumentViewId

fn cmp(&self, other: &DocumentViewId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DocumentViewId

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

fn partial_cmp(&self, other: &DocumentViewId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for DocumentViewId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[Hash]> for DocumentViewId

type Error = DocumentViewIdError

The type returned in the event of a conversion error.

fn try_from(str_list: &[Hash]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&[String]> for DocumentViewId

type Error = DocumentViewIdError

The type returned in the event of a conversion error.

fn try_from(str_list: &[String]) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: HashId> TryFrom<&[T]> for DocumentViewId

type Error = DocumentViewIdError

The type returned in the event of a conversion error.

fn try_from(str_list: &[T]) -> Result<Self, Self::Error>

Performs the conversion.

impl Validate for DocumentViewId

fn validate(&self) -> Result<(), Self::Error>

Checks document view id against canonic format.

This verifies if the document view id is not empty and constituting operation ids are sorted, do not contain any duplicates and represent valid hashes (#OP3).

type Error = DocumentViewIdError

Validation error type.

impl Eq for DocumentViewId

impl StructuralPartialEq for DocumentViewId