Struct FirestoreCollectionId 

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

A Firestore collection ID that has been checked against Firestore’s ID rules.

Construct one with FirestoreCollectionId::new at the point a collection name enters your system — the natural case is a collection chosen at runtime, where an unchecked / would silently re-target the operation at a different collection. It has the same API shape, and the same design rationale (no consuming unwrap, no reserved-namespace check, the String escape hatch), as FirestoreDocumentId; see that type’s docs for the full explanation.

use firestore::FirestoreCollectionId;

let id = FirestoreCollectionId::new("users").expect("valid collection id");
assert_eq!(id.as_str(), "users");

let err = FirestoreCollectionId::new("a/b").unwrap_err();
assert!(err.to_string().contains("collection_id"));
assert!(err.to_string().contains(".parent("));

let err = FirestoreCollectionId::new("").unwrap_err();
assert!(err.to_string().contains("collection_id"));

Drop-in by reference into the fluent API, exactly like FirestoreDocumentId:

use firestore::{FirestoreCollectionId, FirestoreDb, FirestoreResult};

let db = FirestoreDb::new("my-project").await?;
let collection = FirestoreCollectionId::new("users")?;

let documents = db.fluent().list().from(&collection).stream_all().await?;

Stored in a caller’s own struct:

use firestore::FirestoreCollectionId;

struct DynamicCollectionRequest {
    collection: FirestoreCollectionId,
}

let request = DynamicCollectionRequest {
    collection: FirestoreCollectionId::new("users")?,
};
assert_eq!(request.collection.as_str(), "users");

Implementations

impl FirestoreCollectionId

pub fn new<S: Into<String>>(id: S) -> FirestoreResult<Self>

Validates id and wraps it.

Errors

Returns FirestoreError::InvalidParametersError if id is empty, longer than 1500 bytes, contains /, or is exactly "." or "..".

pub fn validate_str(id: &str) -> FirestoreResult<()>

Validates id without allocating or constructing a value.

Errors

Same conditions as FirestoreCollectionId::new.

pub fn validate(&self) -> FirestoreResult<()>

Re-validates an already-constructed ID.

A valid FirestoreCollectionId cannot become invalid after construction, so this always succeeds; it exists to mirror FirestoreListenerTarget::validate for callers that validate every ID-like value the same way.

Errors

Never fails; returns FirestoreResult<()> for symmetry with FirestoreCollectionId::validate_str.

pub const fn from_static(id: &'static str) -> Self

Validates id at compile time and wraps it without allocating, for a name known up front.

Declare validated names the way you would declare const NAME: &str = "..." today:

use firestore::FirestoreCollectionId;

const USERS: FirestoreCollectionId = FirestoreCollectionId::from_static("users");
assert_eq!(USERS.as_str(), "users");

Used in a const or static item, an invalid literal is a compile error: evaluating the item panics, which rustc reports at the definition site rather than letting the invalid value reach a binary. Called from inside a function body, where the result is only a runtime value, the same invalid literal panics instead, exactly like an out-of-bounds const fn array index would.

use firestore::FirestoreCollectionId;
const BAD: FirestoreCollectionId = FirestoreCollectionId::from_static("a/b");

Panics

Panics if id is empty, longer than 1500 bytes, contains /, or is exactly "." or "..", and the call is not evaluated at compile time.

pub fn value(&self) -> &str

Returns the wrapped ID.

Equivalent to as_str; kept as a separate method so a validated ID reads the same as rvstruct::ValueStruct::value elsewhere in this crate’s API. There is no consuming equivalent that returns an owned String (see the FirestoreDocumentId type docs for why). Use id.as_str().to_string() when an owned copy is genuinely needed.

pub fn as_str(&self) -> &str

Returns the wrapped ID as a &str. Equivalent to value.

Trait Implementations

impl AsRef<str> for FirestoreCollectionId

fn as_ref(&self) -> &str

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

impl Borrow<str> for FirestoreCollectionId

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for FirestoreCollectionId

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FirestoreCollectionId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FirestoreCollectionId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FirestoreCollectionId

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

Formats the value using the given formatter.

impl Eq for FirestoreCollectionId

impl From<&FirestoreCollectionId> for FirestoreQueryCollection

fn from(collection_id: &FirestoreCollectionId) -> Self

Converts to this type from the input type.

impl From<FirestoreCollectionId> for FirestoreQueryCollection

fn from(collection_id: FirestoreCollectionId) -> Self

Converts to this type from the input type.

impl FromStr for FirestoreCollectionId

type Err = FirestoreError

The associated error which can be returned from parsing.

fn from_str(id: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for FirestoreCollectionId

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 FirestoreCollectionId

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for FirestoreCollectionId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for FirestoreCollectionId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<FirestoreCollectionId> for str

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<FirestoreCollectionId> for &str

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<FirestoreCollectionId> for String

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<String> for FirestoreCollectionId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for FirestoreCollectionId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FirestoreCollectionId

fn partial_cmp(&self, other: &Self) -> 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 Serialize for FirestoreCollectionId

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FirestoreCollectionId

impl TryFrom<&str> for FirestoreCollectionId

type Error = FirestoreError

The type returned in the event of a conversion error.

fn try_from(id: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for FirestoreCollectionId

type Error = FirestoreError

The type returned in the event of a conversion error.

fn try_from(id: String) -> Result<Self, Self::Error>

Performs the conversion.