Skip to main content

SafePathSegment

Struct SafePathSegment 

Source
pub struct SafePathSegment<'a>(/* private fields */);
Expand description

A single URL path segment, checked at construction not to be exactly . or ...

A percent-encoded ./.. segment (. is an RFC 3986 unreserved character, so encoding leaves it unchanged) still gets collapsed by a URL parser’s dot-segment normalization (RFC 3986 §5.2.4) once interpolated into a request URL, letting it retarget the request off the intended path prefix. A registry-fetch URL builder that takes SafePathSegment instead of a raw &str/String cannot be called with an unchecked value — the dot-segment guard is enforced by the type system rather than by caller convention.

Borrows rather than owns: every caller in this workspace validates a segment immediately before building a URL from it and never stores the checked value, so an owned String would only add an allocation. Copy for the same reason — passing it to more than one URL builder (e.g. NuGet’s flat-container and registration-index URLs, built from the same package name) needs no explicit .clone().

§Examples

use deps_core::path_segment::SafePathSegment;

assert!(SafePathSegment::new("left-pad").is_ok());
assert!(SafePathSegment::new(".").is_err());
assert!(SafePathSegment::new("..").is_err());

Implementations§

Source§

impl<'a> SafePathSegment<'a>

Source

pub fn new(segment: &'a str) -> Result<Self, DotSegmentError<'a>>

§Errors

Returns DotSegmentError if segment is exactly . or ...

Source

pub fn checked_or_reject( segment: &'a str, name: &str, context: &str, registry: &'static str, ) -> Result<Self>

Validates segment, converting a rejection directly into the registry-specific DepsError::PackageNotFound via dot_segment_rejection_error — the single call every ecosystem crate’s own dot-segment gate (deps-composer, deps-dart, deps-npm, deps-nuget) used to hand-roll separately as a SafePathSegment::new(...)

  • .map_err(...) pair (#1514 item 4 follow-up).

name is the full, possibly compound identifier surfaced in the resulting log/error — not necessarily segment itself: a compound name (Composer’s vendor/package, npm’s @scope/pkg) is split into more than one segment before each is checked here, and the rejection should report the whole declared name a user recognizes, not just whichever half happened to be the offending one.

§Errors

Returns DepsError::PackageNotFound if segment is exactly . or ...

§Examples
use deps_core::path_segment::SafePathSegment;

assert!(SafePathSegment::checked_or_reject("left-pad", "left-pad", "example URL", "npm").is_ok());
assert!(SafePathSegment::checked_or_reject("..", "@a/..", "example URL", "npm").is_err());
Source

pub const fn as_str(&self) -> &'a str

The validated segment’s underlying string.

Trait Implementations§

Source§

impl<'a> Clone for SafePathSegment<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for SafePathSegment<'a>

Source§

impl<'a> Debug for SafePathSegment<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for SafePathSegment<'_>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Eq for SafePathSegment<'a>

Source§

impl<'a> Hash for SafePathSegment<'a>

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<'a> PartialEq for SafePathSegment<'a>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for SafePathSegment<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for SafePathSegment<'a>

§

impl<'a> RefUnwindSafe for SafePathSegment<'a>

§

impl<'a> Send for SafePathSegment<'a>

§

impl<'a> Sync for SafePathSegment<'a>

§

impl<'a> Unpin for SafePathSegment<'a>

§

impl<'a> UnsafeUnpin for SafePathSegment<'a>

§

impl<'a> UnwindSafe for SafePathSegment<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more