Struct DatabaseId

pub struct DatabaseId(/* private fields */);

A database id.

Limit

https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases/create#query-parameters

This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

“(default)” database id is also valid.

Examples

use firestore_path::DatabaseId;
use std::str::FromStr;

let database_id = DatabaseId::from_str("my-database")?;
assert_eq!(database_id.as_ref(), "my-database");
assert_eq!(database_id.to_string(), "my-database");

let database_id = DatabaseId::from_str("(default)")?;
assert_eq!(database_id.as_ref(), "(default)");
assert_eq!(database_id.to_string(), "(default)");

let database_id = DatabaseId::default();
assert_eq!(database_id.as_ref(), "(default)");
assert_eq!(database_id.to_string(), "(default)");

Trait Implementations

impl AsRef<str> for DatabaseId

fn as_ref(&self) -> &str

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

impl Clone for DatabaseId

fn clone(&self) -> DatabaseId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DatabaseId

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

Formats the value using the given formatter.

impl Default for DatabaseId

fn default() -> Self

Returns a new instance with the value "(default)".

Examples

use firestore_path::DatabaseId;
assert_eq!(DatabaseId::default().to_string(), "(default)");

impl Display for DatabaseId

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

Formats the value using the given formatter.

impl From<DatabaseName> for DatabaseId

fn from(database_name: DatabaseName) -> Self

Converts to this type from the input type.

impl FromStr for DatabaseId

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 DatabaseId

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 DatabaseId

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

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

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

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 DatabaseId

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 DatabaseId

impl StructuralPartialEq for DatabaseId