Struct DocumentName 

pub struct DocumentName { /* private fields */ }

Represents a fully-qualified Firestore document name.

Implementations

impl DocumentName

pub fn name(&self) -> String

Returns this document name as a fully-qualified string.

pub fn leaf_name(&self) -> &str

pub fn parse(name: &str) -> Result<Self, ParseError>

Parse a document name from a fully-qualified string.

Trait Implementations

impl Clone for DocumentName

fn clone(&self) -> DocumentName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentName

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

Formats the value using the given formatter.

impl Hash for DocumentName

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 DocumentName

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

fn qualify(&self, parent: &CollectionName) -> Result<DocumentName, QualifyError>

Create a document name from self, using the given collection as its parent.

impl Eq for DocumentName

impl StructuralPartialEq for DocumentName