Struct CollectionName

pub struct CollectionName { /* private fields */ }

A collection name.

Format

{root_document_name}/{collection_path}

Examples

use firestore_path::{CollectionName,CollectionPath};
use std::str::FromStr;

let collection_name = CollectionName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms"
)?;
assert_eq!(
    collection_name.to_string(),
    "projects/my-project/databases/my-database/documents/chatrooms"
);

assert_eq!(
    collection_name.collection_path(),
    &CollectionPath::from_str("chatrooms")?
);

assert_eq!(
    CollectionPath::from(collection_name),
    CollectionPath::from_str("chatrooms")?
);

Implementations

impl CollectionName

pub fn new<D>(root_document_name: D, collection_path: CollectionPath) -> Self

where D: Into<RootDocumentName>,

Creates a new CollectionName.

Examples

use firestore_path::{CollectionName,CollectionPath,DatabaseName,RootDocumentName};
use std::str::FromStr;

let root_document_name = RootDocumentName::from_str("projects/my-project/databases/my-database/documents")?;
let collection_path = CollectionPath::from_str("chatrooms")?;
let collection_name = CollectionName::new(root_document_name, collection_path);
assert_eq!(
    collection_name.to_string(),
    "projects/my-project/databases/my-database/documents/chatrooms"
);

let database_name = DatabaseName::from_str("projects/my-project/databases/my-database")?;
let collection_path = CollectionPath::from_str("chatrooms")?;
let collection_name = CollectionName::new(database_name, collection_path);
assert_eq!(
    collection_name.to_string(),
    "projects/my-project/databases/my-database/documents/chatrooms"
);

pub fn collection_id(&self) -> &CollectionId

Returns the CollectionId of this CollectionName.

Examples

use firestore_path::{CollectionId,CollectionName};
use std::str::FromStr;

let collection_name = CollectionName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms"
)?;
assert_eq!(
    collection_name.collection_id(),
    &CollectionId::from_str("chatrooms")?
);

pub fn collection_path(&self) -> &CollectionPath

Returns the CollectionPath of this CollectionName.

Examples

use firestore_path::{CollectionName,CollectionPath};
use std::str::FromStr;

let collection_name = CollectionName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms"
)?;
assert_eq!(
    collection_name.collection_path(),
    &CollectionPath::from_str("chatrooms")?
);

pub fn database_name(&self) -> &DatabaseName

Returns the DatabaseName of this CollectionName.

Examples

use firestore_path::{DatabaseName,CollectionName};
use std::str::FromStr;

let collection_name = CollectionName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms"
)?;
assert_eq!(
    collection_name.database_name(),
    &DatabaseName::from_str("projects/my-project/databases/my-database")?
);

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

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

Creates a new DocumentName from this CollectionName and document_id.

Examples

use firestore_path::{CollectionId,CollectionName,DocumentName};
use std::str::FromStr;

let collection_name = CollectionName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms"
)?;
assert_eq!(
    collection_name.doc("chatroom1")?,
    DocumentName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
    )?
);
assert_eq!(
    collection_name.doc("chatroom2")?,
    DocumentName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom2"
    )?
);

pub fn into_doc<E, T>(self, document_id: T) -> Result<DocumentName, Error>

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

Creates a new DocumentName by consuming the CollectionName with the provided document_id.

Examples

use firestore_path::{CollectionId,CollectionName,DocumentName};
use std::str::FromStr;

let collection_name = CollectionName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms"
)?;
assert_eq!(
    collection_name.clone().into_doc("chatroom1")?,
    DocumentName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
    )?
);
assert_eq!(
    collection_name.into_doc("chatroom2")?,
    DocumentName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom2"
    )?
);

pub fn into_parent(self) -> Option<DocumentName>

Consumes the CollectionName, returning the parent DocumentName.

Examples

use firestore_path::{CollectionId,CollectionName,DocumentName};
use std::str::FromStr;

let collection_name = CollectionName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms"
)?;
assert_eq!(collection_name.into_parent(), None);

let collection_name = CollectionName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms/chatroom1/messages"
)?;
assert_eq!(
    collection_name.clone().into_parent(),
    Some(DocumentName::from_str(
      "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
    )?)
);
assert_eq!(
    collection_name.into_parent(),
    Some(DocumentName::from_str(
      "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
    )?)
);

pub fn into_root_document_name(self) -> RootDocumentName

Consumes the CollectionName, returning the RootDocumentName.

Examples

use firestore_path::{CollectionName,RootDocumentName};
use std::str::FromStr;

let collection_name = CollectionName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms"
)?;
let root_document_name = collection_name.into_root_document_name();
assert_eq!(
    root_document_name,
    RootDocumentName::from_str(
        "projects/my-project/databases/my-database/documents"
    )?
);

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

Returns the parent DocumentName of this CollectionName.

Examples

use firestore_path::{CollectionId,CollectionName,DocumentName};
use std::str::FromStr;

let collection_name = CollectionName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms"
)?;
assert_eq!(collection_name.parent(), None);

let collection_name = CollectionName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms/chatroom1/messages"
)?;
assert_eq!(
    collection_name.parent(),
    Some(DocumentName::from_str(
      "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
    )?)
);
assert_eq!(
    collection_name.parent(),
    Some(DocumentName::from_str(
      "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
    )?)
);

pub fn root_document_name(&self) -> &RootDocumentName

Returns the RootDocumentName of this CollectionName.

Examples

use firestore_path::{CollectionName,RootDocumentName};
use std::str::FromStr;

let collection_name = CollectionName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms"
)?;
let root_document_name = collection_name.root_document_name();
assert_eq!(
    root_document_name,
    &RootDocumentName::from_str(
        "projects/my-project/databases/my-database/documents"
    )?
);

Trait Implementations

impl Clone for CollectionName

fn clone(&self) -> CollectionName

Returns a duplicate 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 Display for CollectionName

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

Formats the value using the given formatter.

impl From<CollectionName> for CollectionId

fn from(collection_name: CollectionName) -> Self

Converts to this type from the input type.

impl From<CollectionName> for CollectionPath

fn from(collection_name: CollectionName) -> Self

Converts to this type from the input type.

impl From<CollectionName> for DatabaseName

fn from(collection_name: CollectionName) -> Self

Converts to this type from the input type.

impl FromStr for CollectionName

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 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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CollectionName

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

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

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

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 CollectionName

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 CollectionName

impl StructuralPartialEq for CollectionName