Struct DocumentId 

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

Unique identifier for an automerge document.

Document IDs are used throughout the sync protocol to identify which document sync messages relate to. They are arbitrary byte arrays that uniquely identify a document.

Implementations

impl DocumentId

pub fn new<R: Rng>(rng: &mut R) -> Self

Creates a new random document ID.

Trait Implementations

impl Clone for DocumentId

fn clone(&self) -> DocumentId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DocumentId

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

Formats the value using the given formatter.

impl From<&DocumentId> for AutomergeUrl

fn from(id: &DocumentId) -> Self

Converts to this type from the input type.

impl FromStr for DocumentId

type Err = BadDocumentId

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 DocumentId

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 Ord for DocumentId

fn cmp(&self, other: &DocumentId) -> 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 DocumentId

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

fn partial_cmp(&self, other: &DocumentId) -> 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 DocumentId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Vec<u8>> for DocumentId

type Error = BadDocumentId

The type returned in the event of a conversion error.

fn try_from(v: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for DocumentId

impl StructuralPartialEq for DocumentId