Struct DocumentPath

pub struct DocumentPath { /* private fields */ }

A document path.

Format

{collection_path}/{document_id}

Examples

use firestore_path::DocumentPath;
use std::str::FromStr;

let document_path = DocumentPath::from_str("chatrooms/chatroom1")?;
assert_eq!(document_path.to_string(), "chatrooms/chatroom1");

Implementations

impl DocumentPath

pub fn new(collection_path: CollectionPath, document_id: DocumentId) -> Self

Creates a new DocumentPath.

Examples

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

let collection_path = CollectionPath::from_str("chatrooms")?;
let document_id = DocumentId::from_str("chatroom1")?;
let document_path = DocumentPath::new(collection_path, document_id);
assert_eq!(document_path.to_string(), "chatrooms/chatroom1");

pub fn collection<E, T>( &self, collection_path: T, ) -> Result<CollectionPath, Error>

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

Creates a new CollectionPath from this DocumentPath and collection_path.

Examples

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

let document_path = DocumentPath::from_str("chatrooms/chatroom1")?;
assert_eq!(
    document_path.collection("messages")?,
    CollectionPath::from_str("chatrooms/chatroom1/messages")?
);
assert_eq!(
    document_path.collection("messages/message1/col")?,
    CollectionPath::from_str("chatrooms/chatroom1/messages/message1/col")?
);
assert_eq!(
    document_path.collection(CollectionId::from_str("messages")?)?,
    CollectionPath::from_str("chatrooms/chatroom1/messages")?
);
assert_eq!(
    document_path.collection(CollectionPath::from_str("messages/message1/col")?)?,
    CollectionPath::from_str("chatrooms/chatroom1/messages/message1/col")?
);

pub fn doc<E, T>(&self, document_path: T) -> Result<DocumentPath, Error>

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

Creates a new DocumentPath from this DocumentPath and document_path.

Examples

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

let document_path = DocumentPath::from_str("chatrooms/chatroom1")?;
assert_eq!(
    document_path.doc("messages/message1")?,
    DocumentPath::from_str("chatrooms/chatroom1/messages/message1")?
);
assert_eq!(
    document_path.doc("messages/message1/col/doc")?,
    DocumentPath::from_str("chatrooms/chatroom1/messages/message1/col/doc")?
);
assert_eq!(
    document_path.doc(DocumentPath::from_str("messages/message1")?)?,
    DocumentPath::from_str("chatrooms/chatroom1/messages/message1")?
);
assert_eq!(
    document_path.doc(DocumentPath::from_str("messages/message1/col/doc")?)?,
    DocumentPath::from_str("chatrooms/chatroom1/messages/message1/col/doc")?
);

pub fn collection_id(&self) -> &CollectionId

Returns the CollectionId of this DocumentPath.

Examples

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

let document_path = DocumentPath::from_str("chatrooms/chatroom1")?;
assert_eq!(
    document_path.collection_id(),
    &CollectionId::from_str("chatrooms")?
);

pub fn document_id(&self) -> &DocumentId

Returns the DocumentId of this DocumentPath.

Examples

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

let document_path = DocumentPath::from_str("chatrooms/chatroom1")?;
assert_eq!(
    document_path.document_id(),
    &DocumentId::from_str("chatroom1")?
);

pub fn into_collection<E, T>( self, collection_path: T, ) -> Result<CollectionPath, Error>

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

Creates a new CollectionPath by consuming the DocumentPath with the provided collection_path.

Examples

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

let document_path = DocumentPath::from_str("chatrooms/chatroom1")?;
assert_eq!(
    document_path.clone().into_collection("messages")?,
    CollectionPath::from_str("chatrooms/chatroom1/messages")?
);
assert_eq!(
    document_path.clone().into_collection("messages/message1/col")?,
    CollectionPath::from_str("chatrooms/chatroom1/messages/message1/col")?
);
assert_eq!(
    document_path.clone().into_collection(CollectionId::from_str("messages")?)?,
    CollectionPath::from_str("chatrooms/chatroom1/messages")?
);
assert_eq!(
    document_path.into_collection(CollectionPath::from_str("messages/message1/col")?)?,
    CollectionPath::from_str("chatrooms/chatroom1/messages/message1/col")?
);

pub fn into_doc<E, T>(self, document_path: T) -> Result<DocumentPath, Error>

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

Creates a new DocumentPath by consuming the DocumentPath with the provided document_path.

Examples

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

let document_path = DocumentPath::from_str("chatrooms/chatroom1")?;
assert_eq!(
    document_path.clone().into_doc("messages/message1")?,
    DocumentPath::from_str("chatrooms/chatroom1/messages/message1")?
);
assert_eq!(
    document_path.clone().into_doc("messages/message1/col/doc")?,
    DocumentPath::from_str("chatrooms/chatroom1/messages/message1/col/doc")?
);
assert_eq!(
    document_path.clone().into_doc(DocumentPath::from_str("messages/message1")?)?,
    DocumentPath::from_str("chatrooms/chatroom1/messages/message1")?
);
assert_eq!(
    document_path.into_doc(DocumentPath::from_str("messages/message1/col/doc")?)?,
    DocumentPath::from_str("chatrooms/chatroom1/messages/message1/col/doc")?
);

pub fn into_parent(self) -> CollectionPath

Consumes the DocumentPath, returning the parent CollectionPath.

Examples

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

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

pub fn parent(&self) -> &CollectionPath

Returns the parent CollectionPath of this DocumentPath.

Examples

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

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

Trait Implementations

impl Clone for DocumentPath

fn clone(&self) -> DocumentPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentPath

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

Formats the value using the given formatter.

impl Display for DocumentPath

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

Formats the value using the given formatter.

impl From<DocumentName> for DocumentPath

fn from(document_name: DocumentName) -> Self

Converts to this type from the input type.

impl From<DocumentPath> for CollectionPath

fn from(document_path: DocumentPath) -> Self

Converts to this type from the input type.

impl From<DocumentPath> for DocumentId

fn from(document_path: DocumentPath) -> Self

Converts to this type from the input type.

impl FromStr for DocumentPath

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 DocumentPath

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 DocumentPath

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

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

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

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 DocumentPath

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 DocumentPath

impl StructuralPartialEq for DocumentPath