Struct RelativePath

pub struct RelativePath(PathBuf);

A representation of a relative file path

RelativePath wraps a PathBuf that is guaranteed to represent a relative file path (i.e. it does not end with a /).

Examples

use std::{path::PathBuf, str::FromStr};

use alpm_types::{Error, RelativePath};

// Create RelativePath from &str
assert_eq!(
    RelativePath::from_str("etc/test.conf"),
    RelativePath::new(PathBuf::from("etc/test.conf"))
);
assert_eq!(
    RelativePath::from_str("/etc/test.conf"),
    Err(Error::PathNotRelative(PathBuf::from("/etc/test.conf")))
);

// Format as String
assert_eq!(
    "test/test.txt",
    RelativePath::from_str("test/test.txt")?.to_string()
);

Tuple Fields

0: PathBuf

Implementations

impl RelativePath

pub fn new(path: PathBuf) -> Result<RelativePath, Error>

Create a new RelativePath

pub fn inner(&self) -> &Path

Return a reference to the inner type

Trait Implementations

impl Clone for RelativePath

fn clone(&self) -> RelativePath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RelativePath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RelativePath

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RelativePath

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

Formats the value using the given formatter.

impl FromStr for RelativePath

fn from_str(s: &str) -> Result<RelativePath, Self::Err>

Parses a relative path from a string

Errors

Returns an error if the path is not relative

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for RelativePath

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RelativePath

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RelativePath

impl StructuralPartialEq for RelativePath