Struct DocumentId 

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

Identifies a document/row across all engines.

Implementations

impl DocumentId

pub fn try_new(id: impl Into<String>) -> Result<Self, IdError>

Construct a DocumentId, validating the input string.

Returns Err(IdError) if the string is empty, exceeds ID_MAX_LEN bytes, or contains a NUL byte.

pub fn from_validated(id: String) -> Self

Construct without validation. Caller must guarantee the input was already validated by try_new (or came from a previously-validated source like deserialized wire bytes from a NodeDB server).

pub fn as_str(&self) -> &str

Trait Implementations

impl Archive for DocumentId

where String: Archive,

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

type Archived = ArchivedDocumentId

The archived representation of this type.

type Resolver = DocumentIdResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

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<__D: Fallible + ?Sized> Deserialize<DocumentId, __D> for Archived<DocumentId>

where String: Archive, <String as Archive>::Archived: Deserialize<String, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<DocumentId, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl Display for DocumentId

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

Formats the value using the given formatter.

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 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<__S: Fallible + ?Sized> Serialize<__S> for DocumentId

where String: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

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

impl StructuralPartialEq for DocumentId