Struct EnvelopeId 

pub struct EnvelopeId(pub String);

Opaque identifier for an import/export envelope.

Assigned by the exporting authority (e.g. Forge). Stable across re-exports of the same logical unit.

Tuple Fields

0: String

Implementations

impl EnvelopeId

pub fn new(value: impl Into<String>) -> Self

Creates an ID from a canonical family-qualified string or a validated payload that will be family-qualified.

Panics when the value is empty, non-canonical, or belongs to a different ID family. Use try_new for untrusted input.

pub fn try_new(value: impl Into<String>) -> Result<Self, IdParseError>

Fallible constructor for untrusted ID input or payloads.

pub fn generate() -> Self

Generate a new random UUID v4 ID.

pub fn as_str(&self) -> &str

Borrow as a string slice.

pub fn is_empty(&self) -> bool

Returns true if the inner string is empty.

Valid IDs are never empty; retained for source compatibility.

Trait Implementations

impl AsRef<str> for EnvelopeId

fn as_ref(&self) -> &str

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

impl Clone for EnvelopeId

fn clone(&self) -> EnvelopeId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnvelopeId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EnvelopeId

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EnvelopeId

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

Formats the value using the given formatter.

impl Eq for EnvelopeId

impl FromStr for EnvelopeId

type Err = IdParseError

The associated error which can be returned from parsing.

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

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

impl Hash for EnvelopeId

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 JsonSchema for EnvelopeId

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

impl Ord for EnvelopeId

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for EnvelopeId

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

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 EnvelopeId