Struct TrustDomain 

pub struct TrustDomain { /* private fields */ }

A validated SPIFFE trust domain.

A TrustDomain represents the authority component of a SPIFFE ID and is guaranteed to contain only characters allowed by the SPIFFE specification: https://github.com/spiffe/spiffe/blob/main/standards/SPIFFE-ID.md#21-trust-domain.

Trust domains must be lowercase. Inputs containing uppercase letters or other disallowed characters are rejected with SpiffeIdError::BadTrustDomainChar instead of being silently normalized.

If you accept user-provided trust domain names, normalize them (e.g., convert to lowercase and validate) before constructing a TrustDomain.

Implementations

impl TrustDomain

pub fn new(id_or_name: impl AsRef<str>) -> Result<TrustDomain, SpiffeIdError>

Attempts to parse a TrustDomain instance from the given name or spiffe_id string.

Arguments

• id_or_name - Name of a trust domain, it also can be a SPIFFE ID string from which the domain name is extracted.

Errors

If the function cannot parse the input as a Trust domain, a SpiffeIdError variant will be returned.

Examples

use spiffe::TrustDomain;

let trust_domain = TrustDomain::new("domain.test").unwrap();
assert_eq!("domain.test", trust_domain.to_string());
assert_eq!("spiffe://domain.test", trust_domain.id_string());

let trust_domain = TrustDomain::new("spiffe://example.org/path").unwrap();
assert_eq!("example.org", trust_domain.to_string());
assert_eq!("spiffe://example.org", trust_domain.id_string());

pub fn as_str(&self) -> &str

Returns the trust domain name as a string slice.

This is a borrowed view into the underlying trust domain and does not allocate. The returned string is guaranteed to be a valid SPIFFE trust domain according to the specification.

pub fn id_string(&self) -> String

Returns a string representation of the SPIFFE ID of the trust domain, e.g. spiffe://example.org.

Trait Implementations

impl AsRef<str> for TrustDomain

fn as_ref(&self) -> &str

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

impl Clone for TrustDomain

fn clone(&self) -> TrustDomain

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrustDomain

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

Formats the value using the given formatter.

impl Display for TrustDomain

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

Formats the value using the given formatter.

impl FromStr for TrustDomain

type Err = SpiffeIdError

The associated error which can be returned from parsing.

fn from_str(name: &str) -> Result<TrustDomain, <TrustDomain as FromStr>::Err>

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

impl Hash for TrustDomain

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 TrustDomain

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TrustDomain

fn partial_cmp(&self, other: &TrustDomain) -> 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 TryFrom<&str> for TrustDomain

type Error = SpiffeIdError

The type returned in the event of a conversion error.

fn try_from( name: &str, ) -> Result<TrustDomain, <TrustDomain as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<String> for TrustDomain

type Error = SpiffeIdError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<TrustDomain, <TrustDomain as TryFrom<String>>::Error>

Performs the conversion.

impl Eq for TrustDomain

impl StructuralPartialEq for TrustDomain