Struct tiny_firestore_odm::CollectionName

pub struct CollectionName { /* fields omitted */ }

Represents the fully-qualified path of a collection.

Implementations

impl CollectionName

pub fn new(project_id: &str, collection: &str) -> Self

Construct a CollectionName for a top-level collection, i.e. a direct descendent of the root.

Equivalent to new_with_path with an empty path.

pub fn new_with_path(
    project_id: &str,
    path: &[(&str, &str)],
    collection: &str
) -> Self

Construct a CollectionName nested under a document.

pub fn parent(&self) -> ParentDocumentOrRoot

Return a representation of the parent of this collection, which may either be a document or the root.

pub fn parent_collection(&self) -> Option<Self>

Return the collection of the document that this collection is nested under, if it exists.

If this collection is directly under the root, returns None.

pub fn document(&self, name: &str) -> DocumentName

Return a reference to a named document directly under this collection.

pub fn leaf_name(&self) -> String

Returns the short name of this collection without the full path.

pub fn name(&self) -> String

Returns the fully-qualified name of this collection as a string.

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

Attempt to parse a collection name from a slash-delimited string.

Trait Implementations

impl Clone for CollectionName

fn clone(&self) -> CollectionName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CollectionName

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

Formats the value using the given formatter.

impl Hash for CollectionName

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<CollectionName> for CollectionName

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

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

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

This method tests for !=.

impl Eq for CollectionName

impl StructuralEq for CollectionName

impl StructuralPartialEq for CollectionName