Struct uriparse::path::Segment

pub struct Segment<'segment> { /* fields omitted */ }

A segment of a path.

Segments are separated from other segments with the '/' delimiter.

Implementations

impl<'_> Segment<'_>

pub fn as_borrowed(&self) -> Segment<'_>

Returns a new segment which is identical but has as lifetime tied to this segment.

pub fn as_str(&self) -> &str

Returns a str representation of the segment.

Examples

use std::convert::TryFrom;

use uriparse::Segment;

let segment = Segment::try_from("segment").unwrap();
assert_eq!(segment.as_str(), "segment");

pub fn empty() -> Segment<'static>

Constructs a segment that is empty.

Examples

use uriparse::Segment;

assert_eq!(Segment::empty(),  "");

pub fn into_owned(self) -> Segment<'static>

Converts the Segment into an owned copy.

If you construct the segment from a source with a non-static lifetime, you may run into lifetime problems due to the way the struct is designed. Calling this function will ensure that the returned value has a static lifetime.

This is different from just cloning. Cloning the segment will just copy the references, and thus the lifetime will remain the same.

pub fn is_dot_segment(&self) -> bool

Returns whether the segment is a dot segment, i.e., is "." or "..".

Examples

use std::convert::TryFrom;

use uriparse::Segment;

let segment = Segment::try_from("segment").unwrap();
assert!(!segment.is_dot_segment());

let segment = Segment::try_from(".").unwrap();
assert!(segment.is_dot_segment());

let segment = Segment::try_from("..").unwrap();
assert!(segment.is_dot_segment());

pub fn is_double_dot_segment(&self) -> bool

Returns whether the segment is a dot segment, i.e., is "..".

Examples

use std::convert::TryFrom;

use uriparse::Segment;

let segment = Segment::try_from("segment").unwrap();
assert!(!segment.is_double_dot_segment());

let segment = Segment::try_from(".").unwrap();
assert!(!segment.is_double_dot_segment());

let segment = Segment::try_from("..").unwrap();
assert!(segment.is_double_dot_segment());

pub fn is_normalized(&self) -> bool

Returns whether the segment is normalized.

A normalized segment will have no bytes that are in the unreserved character set percent-encoded and all alphabetical characters in percent-encodings will be uppercase.

Examples

use std::convert::TryFrom;

use uriparse::Segment;

let segment = Segment::try_from("segment").unwrap();
assert!(segment.is_normalized());

let mut segment = Segment::try_from("%ff%ff").unwrap();
assert!(!segment.is_normalized());
segment.normalize();
assert!(segment.is_normalized());

pub fn is_single_dot_segment(&self) -> bool

Returns whether the segment is a dot segment, i.e., is ".".

Examples

use std::convert::TryFrom;

use uriparse::Segment;

let segment = Segment::try_from("segment").unwrap();
assert!(!segment.is_single_dot_segment());

let segment = Segment::try_from(".").unwrap();
assert!(segment.is_single_dot_segment());

let segment = Segment::try_from("..").unwrap();
assert!(!segment.is_single_dot_segment());

pub fn normalize(&mut self)

Normalizes the segment such that it will have no bytes that are in the unreserved character set percent-encoded and all alphabetical characters in percent-encodings will be uppercase.

If the segment is already normalized, the function will return immediately. Otherwise, if the segment is not owned, this function will perform an allocation to clone it. The normalization itself though, is done in-place with no extra memory allocations required.

Examples

use std::convert::TryFrom;

use uriparse::Segment;

let mut segment = Segment::try_from("segment").unwrap();
segment.normalize();
assert_eq!(segment, "segment");

let mut segment = Segment::try_from("%ff%41").unwrap();
assert_eq!(segment, "%ff%41");
segment.normalize();
assert_eq!(segment, "%FFA");

Trait Implementations

impl<'_> AsRef<[u8]> for Segment<'_>

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl<'_> AsRef<str> for Segment<'_>

fn as_ref(&self) -> &str

Performs the conversion.

impl<'segment> Clone for Segment<'segment>

fn clone(&self) -> Segment<'segment>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'segment> Debug for Segment<'segment>

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

Formats the value using the given formatter.

impl<'_> Deref for Segment<'_>

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'_> Display for Segment<'_>

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

Formats the value using the given formatter.

impl<'_> Eq for Segment<'_>

impl<'segment> From<Segment<'segment>> for String

fn from(value: Segment<'segment>) -> Self

Performs the conversion.

impl<'_> Hash for Segment<'_>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'a, '_> PartialEq<&'a [u8]> for Segment<'_>

fn eq(&self, other: &&'a [u8]) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, '_> PartialEq<&'a str> for Segment<'_>

fn eq(&self, other: &&'a str) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<[u8]> for Segment<'_>

fn eq(&self, other: &[u8]) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<Segment<'_>> for Segment<'_>

fn eq(&self, other: &Segment<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'segment> PartialEq<Segment<'segment>> for [u8]

fn eq(&self, other: &Segment<'segment>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'segment> PartialEq<Segment<'segment>> for &'a [u8]

fn eq(&self, other: &Segment<'segment>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'segment> PartialEq<Segment<'segment>> for str

fn eq(&self, other: &Segment<'segment>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, 'segment> PartialEq<Segment<'segment>> for &'a str

fn eq(&self, other: &Segment<'segment>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> PartialEq<str> for Segment<'_>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'segment> TryFrom<&'segment [u8]> for Segment<'segment>

type Error = PathError

The type returned in the event of a conversion error.

fn try_from(value: &'segment [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'segment> TryFrom<&'segment str> for Segment<'segment>

type Error = PathError

The type returned in the event of a conversion error.

fn try_from(value: &'segment str) -> Result<Self, Self::Error>

Performs the conversion.