Struct camino::FromPathBufError

pub struct FromPathBufError { /* private fields */ }

A possible error value while converting a PathBuf to a Utf8PathBuf.

Produced by the TryFrom<PathBuf> implementation for Utf8PathBuf.

Examples

use camino::{Utf8PathBuf, FromPathBufError};
use std::convert::{TryFrom, TryInto};
use std::ffi::OsStr;
use std::os::unix::ffi::OsStrExt;
use std::path::PathBuf;

let unicode_path = PathBuf::from("/valid/unicode");
let utf8_path_buf: Utf8PathBuf = unicode_path.try_into().expect("valid Unicode path succeeded");

// Paths on Unix can be non-UTF-8.
let non_unicode_str = OsStr::from_bytes(b"\xFF\xFF\xFF");
let non_unicode_path = PathBuf::from(non_unicode_str);
let err: FromPathBufError = Utf8PathBuf::try_from(non_unicode_path.clone())
    .expect_err("non-Unicode path failed");
assert_eq!(err.as_path(), &non_unicode_path);
assert_eq!(err.into_path_buf(), non_unicode_path);

Implementations

impl FromPathBufError

pub fn as_path(&self) -> &Path

Returns the Path slice that was attempted to be converted to Utf8PathBuf.

pub fn into_path_buf(self) -> PathBuf

Returns the PathBuf that was attempted to be converted to Utf8PathBuf.

pub fn from_path_error(&self) -> FromPathError

Fetches a FromPathError for more about the conversion failure.

At the moment this struct does not contain any additional information, but is provided for completeness.

pub fn into_io_error(self) -> Error

Converts self into a std::io::Error with kind InvalidData.

Many users of FromPathBufError will want to convert it into an io::Error. This is a convenience method to do that.

Trait Implementations

impl Clone for FromPathBufError

fn clone(&self) -> FromPathBufError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FromPathBufError

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

Formats the value using the given formatter.

impl Display for FromPathBufError

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

Formats the value using the given formatter.

impl Error for FromPathBufError

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, demand: &mut Demand<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports.

impl PartialEq<FromPathBufError> for FromPathBufError

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

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

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

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

impl Eq for FromPathBufError

impl StructuralEq for FromPathBufError

impl StructuralPartialEq for FromPathBufError