Struct rdftk_iri::Path

pub struct Path(_);

The path is a component of the “generic URI”, perRFC 3296 §3:

URI that are hierarchical in nature use the slash “/” character for separating hierarchical components. For some file systems, a “/” character (used to denote the hierarchical structure of a URI) is the delimiter used to construct a file name hierarchy, and thus the URI path will look similar to a file pathname. This does NOT imply that the resource is a file or that the URI maps to an actual filesystem pathname.

URI that do not make use of the slash “/” character for separating hierarchical components are considered opaque by the generic URI parser.

Specifically, any absolute URI, that is one having a specified scheme, whose path portion does not start with a slash “/” character should be considered opaque.

Example

use rdftk_iri::Path;
use std::str::FromStr;

let path = Path::from_str("foo").unwrap();
println!("'{}'", path); // prints 'foo'

let path = Path::from_str("/foo/bar").unwrap();
println!("'{}'", path); // prints '/foo/bar'

Implementations

impl Path

pub fn root() -> Self

The root of a path is the path separator character “/”, this will return a new path consisting of only this character.

pub fn well_known() -> Self

Constructs a new well-known path, i.e. it contains the prefix specified in RFC-8615: Well-Known Uniform Resource Identifiers (URIs).

pub fn is_empty(&self) -> bool

Return true if the path is the empty string "" (which is a legal value), else false.

pub fn is_absolute(&self) -> bool

Returns true if this path is an absolute path, else false.

pub fn value(&self) -> &String

Returns the current value of the path as a String.

pub fn resolve(&self, relative_path: &Path) -> IriResult<Self>

self = base

pub fn is_normalized(&self) -> bool

Returns true if this path is fully normalized, else false.

pub fn is_well_known(&self) -> bool

Returns true if this path starts with the well-known prefix defined in RFC-8615: Well-Known Uniform Resource Identifiers (URIs).

pub fn push(&mut self, segment: &str) -> IriResult<()>

Push a new segment onto the end of the path.

pub fn pop(&mut self) -> Option<String>

Pop the last segment from the end of the path, if present.

pub fn has_slug(&self) -> bool

Returns true if this path ends in a slug, else false.

pub fn slug(&mut self) -> Option<String>

Return the slug from the end of the path, if present.

pub fn pop_slug(&mut self) -> Option<String>

Pop the slug from the end of the path, if present.

Trait Implementations

impl Clone for Path

fn clone(&self) -> Path

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl Default for Path

fn default() -> Self

Returns the “default value” for a type.

impl Display for Path

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

Formats the value using the given formatter.

impl From<&'_ Path> for IRI

fn from(path: &Path) -> Self

Performs the conversion.

impl From<Path> for IRI

fn from(path: Path) -> Self

Performs the conversion.

impl FromStr for Path

type Err = IriError

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 Path

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, 

Feeds a slice of this type into the given Hasher.

impl Normalize for Path

fn normalize(self) -> IriResult<Self>

Return a normalized version of self. The default for normalization is to do nothing and return self unchanged.

impl Ord for Path

fn cmp(&self, other: &Path) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Path> for Path

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

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

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

This method tests for !=.

impl PartialOrd<Path> for Path

fn partial_cmp(&self, other: &Path) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PercentEncoding for Path

fn encode(&self, for_uri: bool) -> Self where
    Self: Sized, 

Construct a new value that has been percent encoded. If for_uri is true this method will also encode all non-ascii characters as a sequence of UTF-8 octets in percent encoded form.

impl ValidateStr for Path

fn is_valid(s: &str) -> bool

Return true if the string is a valid representation of Self, else false.

impl Eq for Path

impl StructuralEq for Path

impl StructuralPartialEq for Path