Struct dittolive_ditto::store::collection::document_id::DocumentId

pub struct DocumentId { /* private fields */ }

An identifier for a DittoDocument.

Each DocumentId represents a unique identifier for a document.

Implementations

impl DocumentId

pub fn new<V: Serialize>(value: &V) -> Result<Self, DittoError>

Create a new DocumentId from a serializable value.

panic

This function will panic if the value can’t be serialized into cbor.

pub fn to_query_compatible(
    &self,
    string_primitive_fmt: StringPrimitiveFormat
) -> String

Return a String representation of the DocumentId that can be used in a query string.

pub fn value(&self) -> Value

Return the inner bytes value in a cbor form

pub fn to_cbor(&self) -> Value

Return the inner bytes value in a cbor form

Trait Implementations

impl AsRef<[u8]> for DocumentId

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for DocumentId

fn clone(&self) -> DocumentId

Returns a copy 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 Default for DocumentId

fn default() -> DocumentId

Returns the “default value” for a type.

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<&[u8]> for DocumentId

fn from(slice: &[u8]) -> Self

Converts to this type from the input type.

impl From<&DocumentId> for DocumentId

Convenience impl to avoid having to type .clone() everywhere.

fn from(doc: &DocumentId) -> Self

Converts to this type from the input type.

impl From<Box<[u8], Global>> for DocumentId

fn from(bytes: Box<[u8]>) -> Self

Converts to this type from the input type.

impl From<Vec<u8, Global>> for DocumentId

fn from(bytes: Vec<u8>) -> Self

Converts to this type from the input 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) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<DocumentId> for DocumentId

fn eq(&self, other: &DocumentId) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<DocumentId> 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for DocumentId

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for DocumentId

impl StructuralEq for DocumentId

impl StructuralPartialEq for DocumentId