Struct PathMut 

pub struct PathMut<'a> { /* private fields */ }

Available on crate feature http only.

Mutable view of a Uri’s path component.

Holds the Owned representation of the URI for the guard’s lifetime. Each method modifies the path in place. Drop releases the borrow — no special finalization required.

Implementations

impl<'a> PathMut<'a>

pub fn push_segment( &mut self, segment: impl IntoUriComponent, ) -> &mut PathMut<'a>

Available on crate feature net only.

Append a /-delimited segment, percent-encoding any bytes that aren’t legal in a URI path segment per RFC 3986.

Encodes: ASCII controls, space, ", #, %, /, <, >, ?, [, \, ], ^, `, {, |, }, and every non-ASCII byte. Passes through: ALPHA, DIGIT, -._~, !$&'()*+,;=, :, @. The % itself is encoded to %25 — pass already-decoded values, not pre-encoded ones.

If the current path doesn’t already end with /, one is inserted before the segment. Empty path + push_segment("x") yields /x. /foo + push_segment("bar") yields /foo/bar. /foo/ + push_segment("bar") yields /foo/bar (no double slash).

pub fn pop_segment(&mut self) -> Option<BytesMut>

Available on crate feature net only.

Remove and return the last path segment.

/foo/bar → Some("bar"), path becomes /foo. /foo/ → Some(""), path becomes /foo. /foo → Some("foo"), path becomes empty. Empty path → None. Opaque paths (no /) → the whole path is returned.

The returned bytes are the raw on-wire form (still percent-encoded). Use PathSegment::as_decoded_str on the corresponding PathRef::segments item before mutation if you need the decoded value.

pub fn clear(&mut self) -> &mut PathMut<'a>

Available on crate feature net only.

Clear the path entirely.

pub fn ensure_trailing_slash(&mut self) -> &mut PathMut<'a>

Available on crate feature net only.

Ensure the path ends with exactly one trailing /: appended when missing, left alone when already present. An empty path becomes /.

pub fn push_segments( &mut self, segments: impl IntoUriComponent, ) -> &mut PathMut<'a>

Available on crate feature net only.

Append multiple /-delimited segments at once.

Splits the input on / and pushes each piece via push_segment, so every piece is percent-encoded under the path-segment policy (a literal / inside the input is the separator, not encoded). The normal slash-insertion rule applies, so "a/b" and "/a/b" both append /a/b, internal // collapses to a single separator, and a trailing / yields a trailing empty segment.

"/api" + push_segments("v2/users") → /api/v2/users.

pub fn pop_segments(&mut self, n: usize) -> usize

Available on crate feature net only.

Remove up to n trailing segments, returning the number actually removed (fewer than n if the path runs out first).

Equivalent to calling pop_segment n times, stopping early at an empty path.

pub fn strip_prefix(&mut self, prefix: impl IntoUriComponent) -> bool

Available on crate feature net only.

Strip a leading prefix from the path, re-rooting the remainder with a single leading /. Matching uses the default PathMatchOptions (segment-boundary, percent-decoded, case-sensitive); see strip_prefix_with_opts to allow partial / raw / case-insensitive matching.

Returns true when the prefix matched and was removed; otherwise the path is left unchanged and false is returned.

pub fn strip_prefix_with_opts( &mut self, prefix: impl IntoUriComponent, opts: PathMatchOptions, ) -> bool

Available on crate feature net only.

strip_prefix with explicit PathMatchOptions.

pub fn strip_suffix(&mut self, suffix: impl IntoUriComponent) -> bool

Available on crate feature net only.

Strip a trailing suffix from the path, keeping a single leading /. Matching uses the default PathMatchOptions; see strip_suffix_with_opts for the rest.

Returns true when the suffix matched and was removed.

pub fn strip_suffix_with_opts( &mut self, suffix: impl IntoUriComponent, opts: PathMatchOptions, ) -> bool

Available on crate feature net only.

strip_suffix with explicit PathMatchOptions.

Trait Implementations

impl Debug for PathMut<'_>

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

Formats the value using the given formatter.