Struct FormationId 

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

The id of the formation a session belongs to, matching ^frm_[0-9a-f]{32}$.

Implementations

impl FormationId

pub fn mint() -> Self

A fresh formation id, for a launcher starting a formation’s members.

Two launches of the same formation get two different ids.

pub fn parse(value: &str) -> Result<Self, RuntimeError>

Accept value only if it is exactly a formation id; nothing is trimmed.

The error’s reason names what is wrong with the value and never contains it.

pub fn from_env() -> Result<Option<Self>, RuntimeError>

This session’s formation, read from FORMATION_ID_ENV in the process environment.

Ok(None) for a session nobody placed in a formation — the variable absent, or blank — which is the ordinary case. Any other value that is not a formation id is an error and not an absence: a session that cannot tell which formation it belongs to would be grouped with the wrong one, or with none.

pub fn as_str(&self) -> &str

pub fn minted_at_ms(&self) -> u64

When this id was minted, in milliseconds since the Unix epoch: the first 12 hex digits of its UUIDv7, read the same way retention::session_id_timestamp_ms reads a ses_ id.

A member’s session is minted after the formation it joins, so a reader looking for members can pass over every session older than this.

pub fn env_pair(&self) -> (&'static str, String)

The (name, value) pair a launcher writes into a member’s or a child’s environment.

Trait Implementations

impl Clone for FormationId

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 FormationId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FormationId

Only through FormationId::parse, so a file carrying anything but a formation id does not deserialize at all. The error names what is wrong and never contains the value.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for FormationId

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

Formats the value using the given formatter.

impl Eq for FormationId

impl Hash for FormationId

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 PartialEq for FormationId

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FormationId

A bare string, "frm_…".

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FormationId