Struct DatabaseName

pub struct DatabaseName { /* private fields */ }

A database name.

Format

projects/{project_id}/databases/{database_id}

Examples

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

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

assert_eq!(
    database_name.root_document_name(),
    RootDocumentName::from_str("projects/my-project/databases/(default)/documents")?
);

assert_eq!(
    database_name.database_id(),
    &DatabaseId::from_str("(default)")?
);
assert_eq!(
    database_name.project_id(),
    &ProjectId::from_str("my-project")?
);

assert_eq!(
    DatabaseId::from(database_name.clone()),
    DatabaseId::from_str("(default)")?
);
assert_eq!(
    ProjectId::from(database_name.clone()),
    ProjectId::from_str("my-project")?
);

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

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

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

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

pub fn from_project_id<P>(project_id: P) -> Result<Self, Error>

where P: TryInto<ProjectId>, P::Error: Display,

Creates a new DatabaseName with the provided project_id and default database_id.

Examples

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

let database_name = DatabaseName::from_project_id("my-project")?;
assert_eq!(database_name.to_string(), "projects/my-project/databases/(default)");
let project_id = ProjectId::from_str("my-project")?;
let database_name = DatabaseName::from_project_id(project_id)?;
assert_eq!(database_name.to_string(), "projects/my-project/databases/(default)");

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 DatabaseName and collection_path.

Examples

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

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

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 the DatabaseName with the provided collection_path.

Examples

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

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

pub fn database_id(&self) -> &DatabaseId

Returns the DatabaseId of this DatabaseName.

Examples

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

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

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 DatabaseName and document_path.

Examples

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

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

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 DatabaseName with the provided document_path.

Examples

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

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

pub fn into_root_document_name(self) -> RootDocumentName

Consumes the DatabaseName, returning the 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!(
    database_name.into_root_document_name(),
    RootDocumentName::from_str("projects/my-project/databases/my-database/documents")?
);

pub fn project_id(&self) -> &ProjectId

Returns the ProjectId of this DatabaseName.

Examples

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

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

pub fn root_document_name(&self) -> RootDocumentName

Returns a new RootDocumentName from this DatabaseName.

Examples

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

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

Trait Implementations

impl Clone for DatabaseName

fn clone(&self) -> DatabaseName

Returns a duplicate 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<DatabaseName> for DatabaseId

fn from(database_name: DatabaseName) -> Self

Converts to this type from the input type.

impl From<DatabaseName> for ProjectId

fn from(database_name: DatabaseName) -> Self

Converts to this type from the input type.

impl From<DatabaseName> for RootDocumentName

fn from(database_name: DatabaseName) -> 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 From<RootDocumentName> for DatabaseName

fn from(root_document_name: RootDocumentName) -> 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,

Restrict a value to a certain interval.

impl PartialEq for DatabaseName

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

Tests for self and other values to be equal, and is used by ==.

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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 StructuralPartialEq for DatabaseName