Struct RootDocumentName

Source

pub struct RootDocumentName { /* private fields */ }

Expand description

A root document name.

§Format

{database_name}/documents

§Examples

use firestore_path::RootDocumentName;
use std::str::FromStr;

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

Implementations§

Source §

impl RootDocumentName

Source

pub fn new(database_name: DatabaseName) -> Self

Creates a new RootDocumentName.

§Examples

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

let database_name = DatabaseName::from_str(
    "projects/my-project/databases/my-database"
)?;
assert_eq!(
    RootDocumentName::new(database_name),
    RootDocumentName::from_str(
        "projects/my-project/databases/my-database/documents"
    )?
);

Source

pub fn collection<E, T>( &self, collection_path: T, ) -> Result<CollectionName, Error>
where E: Display, T: TryInto<CollectionPath, Error = E>,

Creates a new CollectionName from this RootDocumentName and collection_path.

§Examples

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

let root_document_name = RootDocumentName::from_str(
    "projects/my-project/databases/my-database/documents"
)?;
assert_eq!(
    root_document_name.collection("chatrooms")?,
    CollectionName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms"
    )?
);
assert_eq!(
    root_document_name.collection("chatrooms/chatroom1/messages")?,
    CollectionName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom1/messages"
    )?
);
assert_eq!(
    root_document_name.collection(CollectionId::from_str("chatrooms")?)?,
    CollectionName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms"
    )?
);
assert_eq!(
    root_document_name.collection(CollectionPath::from_str("chatrooms/chatroom1/messages")?)?,
    CollectionName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom1/messages"
    )?
);

Source

pub fn into_collection<E, T>( self, collection_path: T, ) -> Result<CollectionName, Error>
where E: Display, T: TryInto<CollectionPath, Error = E>,

Creates a new CollectionName by consuming RootDocumentName with the provided collection_path.

§Examples

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

let root_document_name = RootDocumentName::from_str(
    "projects/my-project/databases/my-database/documents"
)?;
assert_eq!(
    root_document_name.clone().into_collection("chatrooms")?,
    CollectionName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms"
    )?
);
assert_eq!(
    root_document_name.clone().into_collection("chatrooms/chatroom1/messages")?,
    CollectionName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom1/messages"
    )?
);
assert_eq!(
    root_document_name.clone().into_collection(CollectionId::from_str("chatrooms")?)?,
    CollectionName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms"
    )?
);
assert_eq!(
    root_document_name.into_collection(CollectionPath::from_str("chatrooms/chatroom1/messages")?)?,
    CollectionName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom1/messages"
    )?
);

Source

pub fn doc<E, T>(&self, document_path: T) -> Result<DocumentName, Error>
where E: Display, T: TryInto<DocumentPath, Error = E>,

Creates a new DocumentName from this RootDocumentName and document_path.

§Examples

use firestore_path::{DocumentName,DocumentPath,RootDocumentName};
use std::str::FromStr;

let root_document_name = RootDocumentName::from_str(
    "projects/my-project/databases/my-database/documents"
)?;
assert_eq!(
    root_document_name.doc("chatrooms/chatroom1")?,
    DocumentName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
    )?
);
assert_eq!(
    root_document_name.doc("chatrooms/chatroom1/messages/message1")?,
    DocumentName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom1/messages/message1"
    )?
);
assert_eq!(
    root_document_name.doc(DocumentPath::from_str("chatrooms/chatroom1")?)?,
    DocumentName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
    )?
);
assert_eq!(
    root_document_name.doc(DocumentPath::from_str("chatrooms/chatroom1/messages/message1")?)?,
    DocumentName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom1/messages/message1"
    )?
);

Source

pub fn into_doc<E, T>(self, document_path: T) -> Result<DocumentName, Error>
where E: Display, T: TryInto<DocumentPath, Error = E>,

Creates a new DocumentName by consuming the RootDocumentName with the provided document_path.

§Examples

use firestore_path::{DocumentName,DocumentPath,RootDocumentName};
use std::str::FromStr;

let root_document_name = RootDocumentName::from_str(
    "projects/my-project/databases/my-database/documents"
)?;
assert_eq!(
    root_document_name.clone().into_doc("chatrooms/chatroom1")?,
    DocumentName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
    )?
);
assert_eq!(
    root_document_name.clone().into_doc("chatrooms/chatroom1/messages/message1")?,
    DocumentName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom1/messages/message1"
    )?
);
assert_eq!(
    root_document_name.clone().into_doc(DocumentPath::from_str("chatrooms/chatroom1")?)?,
    DocumentName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
    )?
);
assert_eq!(
    root_document_name.doc(DocumentPath::from_str("chatrooms/chatroom1/messages/message1")?)?,
    DocumentName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom1/messages/message1"
    )?
);