Struct CollectionPath

Source

pub struct CollectionPath { /* private fields */ }

Expand description

A collection path.

§Format

{collection_id}
{document_path}/{collection_id}

§Examples

use firestore_path::CollectionPath;
use std::str::FromStr;

let collection_path = CollectionPath::from_str("chatrooms")?;
assert_eq!(collection_path.to_string(), "chatrooms");

let collection_path = CollectionPath::from_str("chatrooms/chatroom1/messages")?;
assert_eq!(collection_path.to_string(), "chatrooms/chatroom1/messages");

Implementations§

Source §

impl CollectionPath

Source

pub fn new(parent: Option<DocumentPath>, collection_id: CollectionId) -> Self

Create a new CollectionPath.

§Examples

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

let collection_id = CollectionId::from_str("chatrooms")?;
let collection_path = CollectionPath::new(None, collection_id);
assert_eq!(collection_path.to_string(), "chatrooms");

let document_path = DocumentPath::from_str("chatrooms/chatroom1")?;
let collection_id = CollectionId::from_str("messages")?;
let collection_path = CollectionPath::new(Some(document_path), collection_id);
assert_eq!(collection_path.to_string(), "chatrooms/chatroom1/messages");

Source

pub fn collection_id(&self) -> &CollectionId

Returns the CollectionId of this CollectionPath.

§Examples

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

let collection_path = CollectionPath::from_str("chatrooms")?;
assert_eq!(collection_path.collection_id(), &CollectionId::from_str("chatrooms")?);

Source

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

Create a new DocumentPath from this CollectionPath and document_id.

§Examples

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

let collection_path = CollectionPath::from_str("chatrooms")?;
assert_eq!(
    collection_path.doc("chatroom1")?,
    DocumentPath::from_str("chatrooms/chatroom1")?
);
assert_eq!(
    collection_path.doc("chatroom2")?,
    DocumentPath::from_str("chatrooms/chatroom2")?
);

Source

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

Create a new DocumentPath by consuming the CollectionPath with the provided document_id.

§Examples

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

let collection_path = CollectionPath::from_str("chatrooms")?;
assert_eq!(
    collection_path.clone().into_doc("chatroom1")?,
    DocumentPath::from_str("chatrooms/chatroom1")?
);
assert_eq!(
    collection_path.into_doc("chatroom2")?,
    DocumentPath::from_str("chatrooms/chatroom2")?
);

Source

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

Consumes the CollectionPath, returning the parent DocumentPath.

§Examples

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

let collection_path = CollectionPath::from_str("chatrooms")?;
assert_eq!(collection_path.into_parent(), None);

let collection_path = CollectionPath::from_str("chatrooms/chatroom1/messages")?;
assert_eq!(collection_path.clone().into_parent(), Some(DocumentPath::from_str("chatrooms/chatroom1")?));
assert_eq!(collection_path.into_parent(), Some(DocumentPath::from_str("chatrooms/chatroom1")?));

Source

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

Returns the parent DocumentPath of this CollectionPath.

§Examples

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

let collection_path = CollectionPath::from_str("chatrooms")?;
assert_eq!(collection_path.parent(), None);

let collection_path = CollectionPath::from_str("chatrooms/chatroom1/messages")?;
assert_eq!(collection_path.parent(), Some(&DocumentPath::from_str("chatrooms/chatroom1")?));