Struct Address 

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

An ordered, non-empty sequence of Segments — a session’s alias.

Displays and parses dot-joined (work.akeyless.build). Non-empty is an invariant of the type, not a runtime check: every constructor is fallible or takes at least one segment, and Address::depth returns NonZeroUsize so the guarantee is visible in the signature.

Implementations

impl Address

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

Parse a dot-joined address. An empty string is AddressError::Empty; any bad segment surfaces with its position.

pub fn from_segments<I>(segments: I) -> Result<Self, AddressError>

where I: IntoIterator<Item = Segment>,

Build from already-validated segments. Fails only on an empty iterator — there is nothing left to check.

pub fn root(segment: Segment) -> Self

A one-segment address. Infallible: one segment is already non-empty.

pub fn segments(&self) -> &[Segment]

The segments, left to right. Never empty.

pub fn leaf(&self) -> &Segment

The rightmost segment.

pub fn depth(&self) -> NonZeroUsize

How many segments. Typed NonZeroUsize because an address with zero segments does not exist.

pub fn parent(&self) -> Option<Self>

This address with its last segment dropped. None at depth 1 — a root has no parent, and the empty address is unrepresentable.

pub fn child(&self, segment: Segment) -> Self

This address extended by one segment.

pub fn starts_with(&self, prefix: &Self) -> bool

Whether prefix is a segment-wise prefix of this address. Segment-wise, never string-wise: work.helm is NOT a prefix of work.helm-charts.

Trait Implementations

impl Clone for Address

fn clone(&self) -> Address

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Address

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Address

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Address

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

Formats the value using the given formatter.

impl Eq for Address

impl From<Address> for String

fn from(v: Address) -> Self

Converts to this type from the input type.

impl FromStr for Address

type Err = AddressError

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 Address

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 Address

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Address

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

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 Address

impl TryFrom<String> for Address

type Error = AddressError

The type returned in the event of a conversion error.

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

Performs the conversion.