Struct SecretRef 

pub struct SecretRef { /* private fields */ }

secret:<realm>/<name>. Deliberately a separate parser from Locator: sharing the grammar would mean a read path could resolve a secret (7.1’s type-level answer). Malformed shapes are E_CONFIG_INVALID.

Implementations

impl SecretRef

pub fn new(realm: &str, name: &str) -> Result<SecretRef, AxError>

The one place a reference is built from its two segments, and so the one place the grammar is spelled. Every writer of a vault place calls this: a caller that assembled secret:<realm>/<name> from a format string could name a place no reader resolves, and the two spellings would drift the first time either is changed.

Errors

E_CONFIG_INVALID when a segment is empty or carries a character outside the reference alphabet.

pub fn parse(raw: &str) -> Result<SecretRef, AxError>

Reads a reference back out of its text. Text that carries the prefix and a / is handed to SecretRef::new, whose refusal names this same text: the two halves of the grammar answer with one error.

Errors

E_CONFIG_INVALID for text that is not a reference.

pub fn realm(&self) -> &str

pub fn name(&self) -> &str

Trait Implementations

impl Clone for SecretRef

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 SecretRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretRef

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

Deserialize this value from the given Serde deserializer.

impl Display for SecretRef

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

Formats the value using the given formatter.

impl Eq for SecretRef

impl Ord for SecretRef

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 SecretRef

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SecretRef

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 SecretRef

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SecretRef