Struct RepoPath 

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

A path relative to the repository root, which starts with / and uses forward slashes. The path / is the root itself.

Implementations

impl RepoPath

pub fn root() -> Self

The repository root.

pub fn parse(s: &str) -> Option<Self>

Parse a /-rooted path. Rejects a relative path, an empty segment, a . or .. segment, and a trailing slash (except on the root).

pub fn from_fs(root: &RepoRoot, path: &Path) -> Option<Self>

Build from a filesystem path inside root. path is absolute or relative to the current directory; it is normalised lexically, so a .. that leaves the root yields None.

pub fn to_fs(&self, root: &RepoRoot) -> PathBuf

The filesystem path under root.

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

The containing directory; None for the root.

pub fn starts_with(&self, dir: &RepoPath) -> bool

Whether this path is dir or lies under it.

pub fn relative(&self) -> &str

The path without its leading slash, as the report prints it.

pub fn as_str(&self) -> &str

The path as written, /-rooted.

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

The path segments.

pub fn file_name(&self) -> &str

The last segment; empty for the root.

pub fn extension(&self) -> Option<&str>

The text after the last . of the file name, if any.

pub fn join(&self, name: &str) -> Option<RepoPath>

self/name.

pub fn resolve_relative(&self, target: &str) -> Option<RepoPath>

Resolve target from this file’s directory, as standard markdown resolves a relative link. .. segments are applied; leaving the root yields None.

Trait Implementations

impl Clone for RepoPath

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 RepoPath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RepoPath

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RepoPath

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

Formats the value using the given formatter.

impl Eq for RepoPath

impl Hash for RepoPath

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 JsonSchema for RepoPath

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for RepoPath

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 RepoPath

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RepoPath

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 RepoPath

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 RepoPath