Struct FirestoreDocumentId 

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

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

Construct one with FirestoreDocumentId::new at the point an ID enters your system, then pass it (by value or by reference) anywhere this crate accepts a document ID, or store it in your own structs.

use firestore::FirestoreDocumentId;

let id = FirestoreDocumentId::new("user-42").expect("valid document id");
assert_eq!(id.as_str(), "user-42");

let err = FirestoreDocumentId::new("a/b").unwrap_err();
assert!(err.to_string().contains("document_id"));

let err = FirestoreDocumentId::new("").unwrap_err();
assert!(err.to_string().contains("document_id"));

It implements AsRef<str> (and &FirestoreDocumentId does too, via the standard library’s blanket impl), so it drops into every document-ID parameter in this crate’s fluent API without a signature change:

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

let db = FirestoreDb::new("my-project").await?;
let id = FirestoreDocumentId::new("user-42")?;

let doc = db.fluent().select().by_id_in("users").one(&id).await?;

A field typed as FirestoreDocumentId carries the same proof, and validates the same way when deserialized — the usual arrival point for an untrusted ID:

use firestore::FirestoreDocumentId;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Deserialize, Serialize)]
struct CreateSession {
    user_id: FirestoreDocumentId,
}

let session = CreateSession {
    user_id: FirestoreDocumentId::new("user-42")?,
};
assert_eq!(session.user_id.as_str(), "user-42");

This departs from FirestoreReference, which derives Deserialize unconditionally and only validates lazily, on parse(). If a field must round-trip an ID without validating it (for example, one already known to be safe, or logged verbatim for diagnostics), keep it typed as String — that is the documented escape hatch, not a gap in this type.

Neither this type nor FirestoreCollectionId implements rvstruct::ValueStruct. That trait requires an into_value(self) -> String alongside value(), and a consuming conversion back to a bare String is exactly what these types exist to discourage: it launders a validated ID back into a value that can be mutated or concatenated while still looking like it came from a checked source. For the same reason there is no into_string() and no From<FirestoreDocumentId> for String — only the read-only value() and as_str() accessors. An owned String is still reachable, deliberately explicitly, via id.as_str().to_string():

use firestore::FirestoreDocumentId;
let id = FirestoreDocumentId::new("user-42").unwrap();
let _owned: String = id.into();

Firestore also exposes Datastore-mode entities with integer IDs as documents literally named __id7__, and such documents are read today through the same path-building code these types back. Validation here therefore does not reject the reserved __*__ namespace: doing so would turn an existing, working read into a client-side error for a case the server only rejects on write. "__id7__" and "__name__" are accepted by FirestoreDocumentId::new and FirestoreCollectionId::new on purpose.

Implementations

impl FirestoreDocumentId

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.

Useful to check a borrowed &str before deciding whether to take ownership of it.

Errors

Same conditions as FirestoreDocumentId::new.

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

Re-validates an already-constructed ID.

A valid FirestoreDocumentId 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 FirestoreDocumentId::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::FirestoreDocumentId;

const WELCOME_DOC: FirestoreDocumentId = FirestoreDocumentId::from_static("welcome");
assert_eq!(WELCOME_DOC.as_str(), "welcome");

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::FirestoreDocumentId;
const BAD: FirestoreDocumentId = FirestoreDocumentId::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 FirestoreDocumentId

fn as_ref(&self) -> &str

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

impl Borrow<str> for FirestoreDocumentId

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for FirestoreDocumentId

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 FirestoreDocumentId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FirestoreDocumentId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FirestoreDocumentId

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

Formats the value using the given formatter.

impl Eq for FirestoreDocumentId

impl FromStr for FirestoreDocumentId

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 FirestoreDocumentId

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 FirestoreDocumentId

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 FirestoreDocumentId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for FirestoreDocumentId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<FirestoreDocumentId> for str

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<FirestoreDocumentId> for &str

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<FirestoreDocumentId> for String

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<String> for FirestoreDocumentId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for FirestoreDocumentId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FirestoreDocumentId

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 FirestoreDocumentId

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 FirestoreDocumentId

impl TryFrom<&str> for FirestoreDocumentId

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 FirestoreDocumentId

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.