Struct DocumentName

pub struct DocumentName { /* private fields */ }

A document name.

Format

{database_name}/{document_path}

Examples

use firestore_path::DocumentName;

let document_name = DocumentName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
)?;
assert_eq!(
    document_name.to_string(),
    "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
);

assert_eq!(
    document_name.clone().collection("messages")?,
    CollectionName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom1/messages"
    )?
);
assert_eq!(document_name.collection_id(), &CollectionId::from_str("chatrooms")?);
assert_eq!(
    document_name.database_name(),
    &DatabaseName::from_str("projects/my-project/databases/my-database")?
);
assert_eq!(document_name.document_id(), &DocumentId::from_str("chatroom1")?);
assert_eq!(document_name.document_path(), &DocumentPath::from_str("chatrooms/chatroom1")?);
assert_eq!(
    document_name.clone().parent(),
    CollectionName::from_str("projects/my-project/databases/my-database/documents/chatrooms")?
);

assert_eq!(
    DocumentPath::from(document_name.clone()),
    DocumentPath::from_str("chatrooms/chatroom1")?
);

Implementations

impl DocumentName

pub fn new<D>(root_document_name: D, document_path: DocumentPath) -> Self

where D: Into<RootDocumentName>,

Creates a new DocumentName.

Examples

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

let root_document_name = RootDocumentName::from_str("projects/my-project/databases/my-database/documents")?;
let document_path = DocumentPath::from_str("chatrooms/chatroom1")?;
let document_name = DocumentName::new(root_document_name, document_path);
assert_eq!(
    document_name.to_string(),
    "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
);

let database_name = DatabaseName::from_str("projects/my-project/databases/my-database")?;
let document_path = DocumentPath::from_str("chatrooms/chatroom1")?;
let document_name = DocumentName::new(database_name, document_path);
assert_eq!(
    document_name.to_string(),
    "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
);

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

Examples

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

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

pub fn collection_id(&self) -> &CollectionId

Returns the CollectionId of this DocumentName.

Examples

use firestore_path::{CollectionId,DocumentName};
use std::str::FromStr;

let document_name = DocumentName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
)?;
assert_eq!(
    document_name.collection_id(),
    &CollectionId::from_str("chatrooms")?
);

pub fn database_name(&self) -> &DatabaseName

Returns the DatabaseName of this DocumentName.

Examples

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

let document_name = DocumentName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
)?;
assert_eq!(
    document_name.database_name(),
    &DatabaseName::from_str("projects/my-project/databases/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 DocumentName and document_path.

Examples

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

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

pub fn document_id(&self) -> &DocumentId

Returns the DocumentId of this DocumentName.

Examples

use firestore_path::{DocumentId,DocumentName};
use std::str::FromStr;

let document_name = DocumentName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
)?;
assert_eq!(document_name.document_id(), &DocumentId::from_str("chatroom1")?);

pub fn document_path(&self) -> &DocumentPath

Returns the DocumentPath of this DocumentName.

Examples

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

let document_name = DocumentName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
)?;
assert_eq!(
    document_name.document_path(),
    &DocumentPath::from_str("chatrooms/chatroom1")?
);

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 from this DocumentName and collection_path.

Examples

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

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

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

Examples

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

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

pub fn into_parent(self) -> CollectionName

Consumes the DocumentName, returning the parent CollectionName.

Examples

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

let document_name = DocumentName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
)?;
assert_eq!(
    document_name.into_parent(),
    CollectionName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms"
    )?
);

pub fn into_parent_document_name(self) -> Option<DocumentName>

Consumes the DocumentName, returning the parent DocumentName.

Examples

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

let document_name = DocumentName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
)?;
assert_eq!(document_name.into_parent_document_name(), None);
let document_name = DocumentName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms/chatroom1/messages/message1"
)?;
assert_eq!(
    document_name.into_parent_document_name(),
    Some(DocumentName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
    )?)
);

pub fn into_root_document_name(self) -> RootDocumentName

Consumes the DocumentName, returning the RootDocumentName.

Examples

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

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

pub fn parent(&self) -> CollectionName

Returns the parent CollectionName of this DocumentName.

Examples

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

let document_name = DocumentName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
)?;
assert_eq!(
    document_name.parent(),
    CollectionName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms"
    )?
);
assert_eq!(
    document_name.parent(),
    CollectionName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms"
    )?
);

pub fn parent_document_name(&self) -> Option<DocumentName>

Returns the parent DocumentName of this DocumentName.

Examples

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

let document_name = DocumentName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
)?;
assert_eq!(document_name.parent_document_name(), None);
let document_name = DocumentName::from_str(
    "projects/my-project/databases/my-database/documents/chatrooms/chatroom1/messages/message1"
)?;
assert_eq!(
    document_name.parent_document_name(),
    Some(DocumentName::from_str(
        "projects/my-project/databases/my-database/documents/chatrooms/chatroom1"
    )?)
);

pub fn root_document_name(&self) -> &RootDocumentName

Returns the RootDocumentName of this DocumentName.

Examples

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

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

Trait Implementations

impl Clone for DocumentName

fn clone(&self) -> DocumentName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentName

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

Formats the value using the given formatter.

impl Display for DocumentName

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

Formats the value using the given formatter.

impl From<DocumentName> for DatabaseName

fn from(document_name: DocumentName) -> Self

Converts to this type from the input type.

impl From<DocumentName> for DocumentId

fn from(document_name: DocumentName) -> Self

Converts to this type from the input type.

impl From<DocumentName> for DocumentPath

fn from(document_name: DocumentName) -> Self

Converts to this type from the input type.

impl FromStr for DocumentName

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 DocumentName

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 DocumentName

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

fn eq(&self, other: &DocumentName) -> 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 DocumentName

fn partial_cmp(&self, other: &DocumentName) -> 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 DocumentName

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 DocumentName

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 DocumentName

impl StructuralPartialEq for DocumentName