Struct FromOsStringError

pub struct FromOsStringError { /* private fields */ }

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

Produced by the TryFrom<OsString> implementation for Utf8PathBuf.

Examples

use camino::{Utf8PathBuf, FromOsStringError};
use std::convert::{TryFrom, TryInto};
use std::ffi::OsStr;
use std::str::FromStr;
use std::ffi::OsString;
use std::os::unix::ffi::OsStrExt;

let unicode_string = OsString::from_str("/valid/unicode").unwrap();
let utf8_path_buf: Utf8PathBuf = unicode_string.try_into()
    .expect("valid Unicode path succeeded");

// Paths on Unix can be non-UTF-8.
let non_unicode_string = OsStr::from_bytes(b"\xFF\xFF\xFF").to_owned();
let err: FromOsStringError = Utf8PathBuf::try_from(non_unicode_string.clone())
    .expect_err("non-Unicode path failed");
assert_eq!(err.as_os_str(), &non_unicode_string);
assert_eq!(err.into_os_string(), non_unicode_string);

Implementations

impl FromOsStringError

pub fn as_os_str(&self) -> &OsStr

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

pub fn into_os_string(self) -> OsString

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

pub fn from_os_str_error(&self) -> FromOsStrError

Fetches a FromOsStrError 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 FromOsStringError will want to convert it into an io::Error. This is a convenience method to do that.

Trait Implementations

impl Clone for FromOsStringError

fn clone(&self) -> FromOsStringError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FromOsStringError

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

Formats the value using the given formatter.

impl Display for FromOsStringError

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

Formats the value using the given formatter.

impl Error for FromOsStringError

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

Returns 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, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl PartialEq for FromOsStringError

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

impl StructuralPartialEq for FromOsStringError