Struct RelPath 

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

A normalised, /-separated path relative to the workspace root.

Guaranteed to be non-empty, to contain no ., .. or empty segments, and to be relative.

Implementations

impl RelPath

pub fn new(raw: &str) -> Result<Self, PathError>

Parses and normalises a workspace-relative path.

Accepts either separator, collapses redundant ones, and drops . segments. Rejects anything that could point outside the workspace.

pub fn as_str(&self) -> &str

The normalised /-separated representation.

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

The path segments, never empty.

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

The containing directory, or None when this path sits at the workspace root.

pub fn file_name(&self) -> &str

The final segment.

pub fn join(&self, segment: &str) -> Result<Self, PathError>

Appends a segment, normalising it in the process.

pub fn relative_to_dir(&self, dir: Option<&RelPath>) -> String

Renders self as a path relative to dir, where None means the workspace root.

This is what a portable symlink stores: linking .claude/skills to .agents/skills should record ../.agents/skills, not an absolute path, so the workspace stays movable.

pub fn starts_with(&self, other: &RelPath) -> bool

Whether self is other or lives underneath it.

Trait Implementations

impl Clone for RelPath

fn clone(&self) -> RelPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelPath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RelPath

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RelPath

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

Formats the value using the given formatter.

impl Eq for RelPath

impl From<RelPath> for String

fn from(value: RelPath) -> Self

Converts to this type from the input type.

impl FromStr for RelPath

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 RelPath

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 RelPath

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RelPath

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

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 RelPath

impl TryFrom<String> for RelPath

type Error = PathError

The type returned in the event of a conversion error.

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

Performs the conversion.