Struct ParentPathBuilder 

pub struct ParentPathBuilder { /* private fields */ }

Re-exports all public items from the db module.

The db module contains the core FirestoreDb client and functionalities for interacting with the Firestore database, such as CRUD operations, queries, and transactions. A builder for constructing Firestore document paths, typically for parent documents when dealing with sub-collections.

ParentPathBuilder allows for fluently creating nested document paths. It starts with an initial document path and allows appending further collection and document ID segments.

This is often used to specify the parent document when performing operations on a sub-collection.

Examples

use firestore::{FirestoreDb, FirestoreResult, ParentPathBuilder};

let db = FirestoreDb::new("my-project").await?;

// Path to "my-collection/my-doc"
let parent_path = db.parent_path("my-collection", "my-doc")?;
assert_eq!(parent_path.to_string(), "projects/my-project/databases/(default)/documents/my-collection/my-doc");

// Path to "my-collection/my-doc/sub-collection/sub-doc"
let sub_collection_path = parent_path.at("sub-collection", "sub-doc")?;
assert_eq!(sub_collection_path.to_string(), "projects/my-project/databases/(default)/documents/my-collection/my-doc/sub-collection/sub-doc");

Implementations

impl ParentPathBuilder

pub fn at<S>( self, collection_name: &str, document_id: S, ) -> FirestoreResult<Self>

where S: AsRef<str>,

Appends a collection name and document ID to the current path.

This method extends the existing path with /collection_name/document_id.

Arguments

• collection_name: The name of the collection to append.
• document_id: The ID of the document within that collection.

Errors

Returns FirestoreError::InvalidParametersError if the document_id is invalid (e.g., contains /).

Trait Implementations

impl AsRef<str> for ParentPathBuilder

fn as_ref(&self) -> &str

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

impl Clone for ParentPathBuilder

fn clone(&self) -> ParentPathBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ParentPathBuilder

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

Formats the value using the given formatter.

impl Display for ParentPathBuilder

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

Formats the value using the given formatter.

impl<'a> From<&'a ParentPathBuilder> for &'a str

fn from(pb: &'a ParentPathBuilder) -> &'a str

Converts to this type from the input type.

impl From<ParentPathBuilder> for String

fn from(pb: ParentPathBuilder) -> Self

Converts to this type from the input type.

impl From<ParentPathBuilder> for FirestoreReference

fn from(pb: ParentPathBuilder) -> Self

Converts to this type from the input type.