Struct SpiffeId

pub struct SpiffeId { /* private fields */ }

Represents a SPIFFE ID.

Implementations

impl SpiffeId

pub fn new(id: &str) -> Result<Self, SpiffeIdError>

Attempts to parse a SPIFFE ID from the given id string.

Arguments

• id - A SPIFFE ID, e.g. ‘spiffe://trustdomain/path/other’

Errors

If the function cannot parse the input as a SPIFFE ID, a SpiffeIdError variant will be returned.

Examples

use spiffe::SpiffeId;

let spiffe_id = SpiffeId::new("spiffe://trustdomain/path").unwrap();
assert_eq!("trustdomain", spiffe_id.trust_domain().to_string());
assert_eq!("/path", spiffe_id.path());

pub fn from_segments( trust_domain: TrustDomain, segments: &[&str], ) -> Result<Self, SpiffeIdError>

Returns a new SPIFFE ID in the given trust domain with joined path segments. The path segments must be valid according to the SPIFFE specification and must not contain path separators. See https://github.com/spiffe/spiffe/blob/main/standards/SPIFFE-ID.md#22-path

Arguments

• trust_domain - A TrustDomain object.
• segments - A slice of path segments.

Errors

If the segments contain not allowed characters, a SpiffeIdError variant will be returned.

Examples

use spiffe::{SpiffeId, TrustDomain};

let trust_domain = TrustDomain::new("trustdomain").unwrap();
let spiffe_id = SpiffeId::from_segments(trust_domain, &["path1", "path2", "path3"]).unwrap();
assert_eq!(
    "spiffe://trustdomain/path1/path2/path3",
    spiffe_id.to_string()
);

pub fn trust_domain(&self) -> &TrustDomain

Returns the trust domain of the SPIFFE ID.

pub fn path(&self) -> &str

Returns the path of the SPIFFE ID.

pub fn is_member_of(&self, trust_domain: &TrustDomain) -> bool

Returns true if this SPIFFE ID has the given TrustDomain.

Trait Implementations

impl Clone for SpiffeId

fn clone(&self) -> SpiffeId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpiffeId

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

Formats the value using the given formatter.

impl Display for SpiffeId

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

Formats the value using the given formatter.

impl FromStr for SpiffeId

type Err = SpiffeIdError

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 SpiffeId

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 SpiffeId

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

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

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

type Error = SpiffeIdError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for SpiffeId

type Error = SpiffeIdError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for SpiffeId

impl StructuralPartialEq for SpiffeId