Struct libpna::EntryReference

pub struct EntryReference(/* private fields */);

A UTF-8 encoded entry reference.

Examples

use libpna::EntryReference;

assert_eq!("uer/bin", EntryReference::from("uer/bin"));
assert_eq!("/user/bin", EntryReference::from("/user/bin"));
assert_eq!("/user/bin", EntryReference::from("/user/bin/"));
assert_eq!("../user/bin", EntryReference::from("../user/bin/"));
assert_eq!("/", EntryReference::from("/"));

Implementations

impl EntryReference

pub fn as_str(&self) -> &str

Extracts a string slice containing the entire EntryReference.

Examples

Basic usage:

use libpna::EntryReference;

let r = EntryReference::from("foo");
assert_eq!("foo", r.as_str());

pub fn as_os_str(&self) -> &OsStr

Converts to an OsStr slice.

Examples

use libpna::EntryReference;
use std::ffi::OsStr;

let entry_name = EntryReference::from("foo.txt");
let os_str = OsStr::new("foo.txt");
assert_eq!(entry_name.as_os_str(), os_str);

pub fn as_path(&self) -> &Path

Coerces to a Path slice.

Examples

use libpna::EntryReference;
use std::path::Path;

let entry_name = EntryReference::from("test/foo.txt");
assert_eq!(Path::new("test/foo.txt"), entry_name.as_path());

pub fn from_lossy<T: Into<PathBuf>>(p: T) -> Self

Create an EntryReference from a struct impl Into<PathBuf>.

Any non-Unicode sequences are replaced with U+FFFD REPLACEMENT CHARACTER.

Examples

use libpna::EntryReference;

assert_eq!("foo.txt", EntryReference::from_lossy("foo.txt"));
assert_eq!("/foo.txt", EntryReference::from_lossy("/foo.txt"));
assert_eq!("./foo.txt", EntryReference::from_lossy("./foo.txt"));
assert_eq!("../foo.txt", EntryReference::from_lossy("../foo.txt"));

Trait Implementations

impl AsRef<OsStr> for EntryReference

fn as_ref(&self) -> &OsStr

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Path> for EntryReference

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for EntryReference

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for EntryReference

fn clone(&self) -> EntryReference

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntryReference

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

Formats the value using the given formatter.

impl Display for EntryReference

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

Formats the value using the given formatter.

impl From<&String> for EntryReference

fn from(value: &String) -> Self

Converts to this type from the input type.

impl From<&str> for EntryReference

fn from(value: &str) -> Self

Examples

use libpna::EntryReference;

assert_eq!("/path/with/root", EntryReference::from("/path/with/root"));

impl From<String> for EntryReference

fn from(value: String) -> Self

Converts to this type from the input type.

impl Hash for EntryReference

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for EntryReference

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<&str> for EntryReference

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

Examples

use libpna::EntryReference;

assert_eq!(EntryReference::from("test.txt"), "test.txt");

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 PartialEq<EntryReference> for &str

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

Examples

use libpna::EntryReference;

assert_eq!("test.txt", EntryReference::from("test.txt"));

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 PartialEq<EntryReference> for str

fn eq(&self, other: &EntryReference) -> 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 PartialEq<str> for EntryReference

fn eq(&self, other: &str) -> 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 PartialEq for EntryReference

fn eq(&self, other: &EntryReference) -> 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 PartialOrd for EntryReference

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<&OsStr> for EntryReference

type Error = EntryReferenceError

The type returned in the event of a conversion error.

fn try_from(value: &OsStr) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Path> for EntryReference

fn try_from(value: &Path) -> Result<Self, Self::Error>

Examples

use libpna::EntryReference;
use std::path::Path;

let p = Path::new("path/to/file");
assert_eq!("path/to/file", EntryReference::try_from(p).unwrap());

type Error = EntryReferenceError

The type returned in the event of a conversion error.

impl Eq for EntryReference

impl StructuralPartialEq for EntryReference