Struct firestore_path::ProjectId

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

A project id.

Limit

https://cloud.google.com/resource-manager/docs/creating-managing-projects

• Must be 6 to 30 characters in length.
• Can only contain lowercase letters, numbers, and hyphens.
• Must start with a letter.
• Cannot end with a hyphen.
• Cannot be in use or previously used; this includes deleted projects.
• Cannot contain restricted strings, such as google, null, undefined, and ssl.

Examples

use firestore_path::ProjectId;
use std::str::FromStr;

let project_id = ProjectId::from_str("my-project")?;
assert_eq!(project_id.as_ref(), "my-project");
assert_eq!(project_id.to_string(), "my-project");

Trait Implementations

impl AsRef<str> for ProjectId

fn as_ref(&self) -> &str

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

impl Clone for ProjectId

fn clone(&self) -> ProjectId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectId

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

Formats the value using the given formatter.

impl Display for ProjectId

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

Formats the value using the given formatter.

impl FromStr for ProjectId

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 ProjectId

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 ProjectId

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

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

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

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 ProjectId

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 ProjectId

impl StructuralEq for ProjectId

impl StructuralPartialEq for ProjectId