Struct firestore_path::CollectionName

source ·

pub struct CollectionName { /* private fields */ }

Expand description

A collection name.

Format

{database_name}/{collection_path}

Examples

use firestore_path::CollectionName;
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"
);

Implementations§

source §

impl CollectionName

source

pub fn new(database_name: DatabaseName, collection_path: CollectionPath) -> Self

Creates a new CollectionName.

Examples

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

let database_name = DatabaseName::from_str("projects/my-project/databases/my-database/documents")?;
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"
);

source

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")?
);

source

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/documents")?
);

source

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"
    )?
);

source

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"
    )?)
);