Struct FilePath

pub struct FilePath<'f>(Cow<'f, CStr>);

File name represented as a nul-terminated byte array.

While zvariant::Type and serde::{Serialize, Deserialize}, are implemented for Path and PathBuf, unfortunately serde serializes them as UTF-8 strings and that limits the number of possible characters to use on a file path. This is not the desired behavior since file paths are not guaranteed to contain only UTF-8 characters.

To solve this problem, this type is provided which encodes the underlying file path as a null-terminated byte array.

Examples:

use zvariant::FilePath;
use std::path::{Path, PathBuf};

let path = Path::new("/hello/world\0");
let path_buf = PathBuf::from(path);

let p1 = FilePath::from(path);
let p2 = FilePath::from(path_buf);
let p3 = FilePath::from("/hello/world");

assert_eq!(p1, p2);
assert_eq!(p2, p3);

Tuple Fields

0: Cow<'f, CStr>

Implementations

impl<'f> FilePath<'f>

pub fn new(cow: Cow<'f, CStr>) -> Self

Trait Implementations

impl<'f> AsRef<FilePath<'f>> for FilePath<'f>

fn as_ref(&self) -> &FilePath<'f>

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

impl<'f> Clone for FilePath<'f>

fn clone(&self) -> FilePath<'f>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'f> Debug for FilePath<'f>

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

Formats the value using the given formatter.

impl<'f> Default for FilePath<'f>

fn default() -> FilePath<'f>

Returns the “default value” for a type.

impl<'de, 'f> Deserialize<'de> for FilePath<'f>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'f> From<&'f CStr> for FilePath<'f>

fn from(value: &'f CStr) -> Self

Converts to this type from the input type.

impl<'f> From<&'f CString> for FilePath<'f>

fn from(value: &'f CString) -> Self

Converts to this type from the input type.

impl<'f> From<&'f FilePath<'f>> for &'f Path

fn from(value: &'f FilePath<'f>) -> Self

Converts to this type from the input type.

impl<'f> From<&'f OsStr> for FilePath<'f>

fn from(value: &'f OsStr) -> FilePath<'f>

Converts to this type from the input type.

impl<'f> From<&'f OsString> for FilePath<'f>

fn from(value: &'f OsString) -> FilePath<'f>

Converts to this type from the input type.

impl<'f> From<&'f Path> for FilePath<'f>

fn from(value: &'f Path) -> Self

Converts to this type from the input type.

impl<'f> From<&'f PathBuf> for FilePath<'f>

fn from(value: &'f PathBuf) -> FilePath<'f>

Converts to this type from the input type.

impl<'f> From<&'f str> for FilePath<'f>

fn from(value: &'f str) -> Self

Converts to this type from the input type.

impl From<CString> for FilePath<'_>

fn from(value: CString) -> Self

Converts to this type from the input type.

impl From<FilePath<'_>> for OsString

fn from(value: FilePath<'_>) -> Self

Converts to this type from the input type.

impl<'f> From<FilePath<'f>> for PathBuf

fn from(value: FilePath<'f>) -> Self

Converts to this type from the input type.

impl From<OsString> for FilePath<'_>

fn from(value: OsString) -> Self

Converts to this type from the input type.

impl From<PathBuf> for FilePath<'_>

fn from(value: PathBuf) -> FilePath<'static>

Converts to this type from the input type.

impl<'f> Ord for FilePath<'f>

fn cmp(&self, other: &FilePath<'f>) -> 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,

Restrict a value to a certain interval.

impl<'f> PartialEq for FilePath<'f>

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

fn partial_cmp(&self, other: &FilePath<'f>) -> 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<'f> Serialize for FilePath<'f>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'f> Type for FilePath<'f>

const SIGNATURE: &'static Signature

The signature for the implementing type, in parsed format.

impl<'f> Eq for FilePath<'f>

impl<'f> StructuralPartialEq for FilePath<'f>