Struct DocumentId

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

A document 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 .*
• If you import Datastore entities into a Firestore database, numeric entity IDs are exposed as id[0-9]+

Examples

use firestore_path::DocumentId;
use std::str::FromStr;

let document_id = DocumentId::from_str("chatroom1")?;
assert_eq!(document_id.as_ref(), "chatroom1");
assert_eq!(document_id.to_string(), "chatroom1");

Trait Implementations

impl AsRef<str> for DocumentId

fn as_ref(&self) -> &str

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

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

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

Formats the value using the given formatter.

impl From<DocumentName> for DocumentId

fn from(document_name: DocumentName) -> Self

Converts to this type from the input type.

impl From<DocumentPath> for DocumentId

fn from(document_path: DocumentPath) -> Self

Converts to this type from the input type.

impl FromStr for DocumentId

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

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

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

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 DocumentId

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 DocumentId

impl StructuralPartialEq for DocumentId