Struct CollectionId

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

A collection id.

Limit

https://firebase.google.com/docs/firestore/quotas#collections_documents_and_fields

• Must be valid UTF-8 characters
• Must be no longer than 1,500 bytes
• Cannot contain a forward slash (/)
• Cannot solely consist of a single period (.) or double periods (..)
• Cannot match the regular expression .*

Examples

use firestore_path::CollectionId;
use std::str::FromStr;

let collection_id = CollectionId::from_str("chatrooms")?;
assert_eq!(collection_id.as_ref(), "chatrooms");
assert_eq!(collection_id.to_string(), "chatrooms");

Trait Implementations

impl AsRef<str> for CollectionId

fn as_ref(&self) -> &str

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

impl Clone for CollectionId

fn clone(&self) -> CollectionId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollectionId

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

Formats the value using the given formatter.

impl Display for CollectionId

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

Formats the value using the given formatter.

impl From<CollectionId> for CollectionPath

fn from(collection_id: CollectionId) -> Self

Converts to this type from the input type.

impl From<CollectionName> for CollectionId

fn from(collection_name: CollectionName) -> Self

Converts to this type from the input type.

impl From<CollectionPath> for CollectionId

fn from(collection_path: CollectionPath) -> Self

Converts to this type from the input type.

impl FromStr for CollectionId

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 CollectionId

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 CollectionId

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

Restrict a value to a certain interval.

impl PartialEq for CollectionId

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

fn partial_cmp(&self, other: &CollectionId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<&str> for CollectionId

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 CollectionId

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 CollectionId

impl StructuralPartialEq for CollectionId