Struct SecretPath 

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

A validated secret path.

Construct one through SecretPath::parse (or "...".parse() via FromStr). The wrapped string is guaranteed to satisfy every rule in ADR-020 §2 at construction time, and the type is the only way the rest of the framework consumes a path.

Implementations

impl SecretPath

pub fn parse(s: &str) -> Result<Self, PathError>

Validate s and return an owned SecretPath.

Equivalent to s.parse::<SecretPath>().

pub fn parse_internal(s: &str) -> Result<Self, PathError>

Like SecretPath::parse but accepts internally-reserved prefixes (__*, _test).

This entry point is only for the framework’s own consumers — for example, the source-credential resolver in ADR-021 §5 reading paths under __sources/.... Production code that takes a path from the user must call SecretPath::parse instead.

pub fn as_str(&self) -> &str

The full path, e.g. "team/gitlab/token-deploy".

pub fn scope(&self) -> &str

The first segment — the scope (e.g. team, personal, client-acme, sandbox, or one of the reserved prefixes when the path was constructed via SecretPath::parse_internal).

pub fn provider(&self) -> &str

The second segment — usually a provider name (gitlab, github, openai, …).

pub fn purpose(&self) -> &str

The third segment — usually a per-credential purpose (token-deploy, pat, api-key, …).

Paths longer than three segments preserve the rest as part of the purpose string returned here (joined with /).

pub fn segments(&self) -> impl Iterator<Item = &str>

Iterate over the path’s /-separated segments.

pub fn is_internal(&self) -> bool

true if the path is in one of the reserved framework namespaces (__* or _test/*). User-facing surfaces hide such paths by default; see ADR-020 §2 and ADR-021 §5.

Trait Implementations

impl AsRef<str> for SecretPath

fn as_ref(&self) -> &str

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

impl Clone for SecretPath

fn clone(&self) -> SecretPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretPath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretPath

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

Deserialize this value from the given Serde deserializer.

impl Display for SecretPath

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

Formats the value using the given formatter.

impl Eq for SecretPath

impl FromStr for SecretPath

type Err = PathError

The associated error which can be returned from parsing.

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

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

impl Hash for SecretPath

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 SecretPath

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

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

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

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SecretPath