Struct firestore_path::DatabaseName

pub struct DatabaseName { /* private fields */ }

A database name.

Format

projects/{project_id}/databases/{database_id}/documents

Examples

use firestore_path::DatabaseName;
use std::str::FromStr;

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

Implementations

impl DatabaseName

pub fn new(project_id: ProjectId, database_id: DatabaseId) -> Self

Creates a new DatabaseName.

Examples

use firestore_path::{DatabaseId,DatabaseName,ProjectId};
use std::str::FromStr;

let project_id = ProjectId::from_str("my-project")?;
let database_id = DatabaseId::from_str("my-database")?;
let database_name = DatabaseName::new(project_id, database_id);
assert_eq!(database_name.to_string(), "projects/my-project/databases/my-database/documents");

pub fn collection<E, T>(self, collection_id: T) -> Result<CollectionName, Error>

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

Creates a new CollectionName from this DatabaseName and collection_id.

Examples

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

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

Trait Implementations

impl Clone for DatabaseName

fn clone(&self) -> DatabaseName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DatabaseName

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

Formats the value using the given formatter.

impl Display for DatabaseName

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

Formats the value using the given formatter.

impl From<CollectionName> for DatabaseName

fn from(collection_name: CollectionName) -> Self

Converts to this type from the input type.

impl From<DocumentName> for DatabaseName

fn from(document_name: DocumentName) -> Self

Converts to this type from the input type.

impl FromStr for DatabaseName

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 DatabaseName

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 DatabaseName

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

Restrict a value to a certain interval.

impl PartialEq for DatabaseName

fn eq(&self, other: &DatabaseName) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for DatabaseName

fn partial_cmp(&self, other: &DatabaseName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&str> for DatabaseName

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 DatabaseName

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 DatabaseName

impl StructuralEq for DatabaseName

impl StructuralPartialEq for DatabaseName