Struct firestore_path::CollectionPath

pub struct CollectionPath { /* private fields */ }

format:

• {collection_id}
• {document_path}/{collection_id}

Implementations

impl CollectionPath

pub fn new(parent: Option<DocumentPath>, collection_id: CollectionId) -> Self

pub fn collection_id(&self) -> &CollectionId

pub fn doc<E, T>(self, document_id: T) -> Result<DocumentPath, Error>

where E: Display, T: TryInto<DocumentId, Error = E>,

pub fn parent(&self) -> Option<&DocumentPath>

Trait Implementations

impl Clone for CollectionPath

fn clone(&self) -> CollectionPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CollectionPath

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

Formats the value using the given formatter.

impl Display for CollectionPath

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

Formats the value using the given formatter.

impl From<CollectionPath> for CollectionId

fn from(collection_path: CollectionPath) -> Self

Converts to this type from the input type.

impl From<CollectionPath> for Option<DocumentPath>

fn from(collection_path: CollectionPath) -> Self

Converts to this type from the input type.

impl From<DocumentPath> for CollectionPath

fn from(document_path: DocumentPath) -> Self

Converts to this type from the input type.

impl FromStr for CollectionPath

type Err = Error

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 CollectionPath

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 CollectionPath

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

Restrict a value to a certain interval.

impl PartialEq for CollectionPath

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

fn partial_cmp(&self, other: &CollectionPath) -> 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 TryFrom<&str> for CollectionPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for CollectionPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for CollectionPath

impl StructuralEq for CollectionPath

impl StructuralPartialEq for CollectionPath