Trait OsStrBytes

pub trait OsStrBytes: Sealed + ToOwned {
    // Required methods
    fn assert_from_raw_bytes<'a, S>(string: S) -> Cow<'a, Self>
       where S: Into<Cow<'a, [u8]>>;
    fn from_io_bytes(string: &[u8]) -> Option<&Self>;
    fn from_raw_bytes<'a, S>(string: S) -> Result<Cow<'a, Self>, EncodingError>
       where S: Into<Cow<'a, [u8]>>;
    fn to_io_bytes(&self) -> Option<&[u8]>;
    fn to_io_bytes_lossy(&self) -> Cow<'_, [u8]>;
    fn to_raw_bytes(&self) -> Cow<'_, [u8]>;
}

A platform agnostic variant of OsStrExt.

For more information, see the module-level documentation.

Required Methods

fn assert_from_raw_bytes<'a, S>(string: S) -> Cow<'a, Self>

where S: Into<Cow<'a, [u8]>>,

Available on crate feature conversions only.

Converts a byte string into an equivalent platform-native string.

Panics

Panics if the string is not valid for the unspecified encoding used by this crate.

Examples

use std::env;
use std::ffi::OsStr;

use os_str_bytes::OsStrBytes;

let os_string = env::current_exe()?;
let os_bytes = os_string.to_raw_bytes();
assert_eq!(os_string, OsStr::assert_from_raw_bytes(os_bytes));

fn from_io_bytes(string: &[u8]) -> Option<&Self>

Converts a byte string into an equivalent platform-native string, if it is IO-safe.

Examples

use std::ffi::OsStr;
use std::io;
use std::io::Read;

use os_str_bytes::OsStrBytes;

let mut io_string = Vec::new();
let _ = io::stdin().read_to_end(&mut io_string)?;
let os_string = OsStr::from_io_bytes(&io_string).ok_or_else(|| {
    io::Error::new(io::ErrorKind::InvalidInput, "invalid input")
})?;
println!("{:?}", os_string);

fn from_raw_bytes<'a, S>(string: S) -> Result<Cow<'a, Self>, EncodingError>

where S: Into<Cow<'a, [u8]>>,

Available on crate feature checked_conversions only.

Converts a byte string into an equivalent platform-native string.

assert_from_raw_bytes should almost always be used instead. For more information, see EncodingError.

Errors

See documentation for EncodingError.

Examples

use std::env;
use std::ffi::OsStr;

use os_str_bytes::OsStrBytes;

let os_string = env::current_exe()?;
let os_bytes = os_string.to_raw_bytes();
assert_eq!(os_string, OsStr::from_raw_bytes(os_bytes).unwrap());

fn to_io_bytes(&self) -> Option<&[u8]>

Converts a platform-native string into an equivalent byte string, if it is IO-safe.

Examples

use std::env;
use std::io;
use std::io::Write;

use os_str_bytes::OsStrBytes;

let os_string = env::current_exe()?;
let io_string = os_string.to_io_bytes().ok_or_else(|| {
    io::Error::new(io::ErrorKind::InvalidInput, "invalid input")
})?;
io::stdout().write_all(io_string)?;

fn to_io_bytes_lossy(&self) -> Cow<'_, [u8]>

Converts a platform-native string into an equivalent byte string.

If the string is not IO-safe, invalid characters will be replaced with REPLACEMENT_CHARACTER.

Examples

use std::env;
use std::io;
use std::io::Write;

use os_str_bytes::OsStrBytes;

let os_string = env::current_exe()?;
let io_string = os_string.to_io_bytes_lossy();
io::stdout().write_all(&io_string)?;

fn to_raw_bytes(&self) -> Cow<'_, [u8]>

Available on crate feature conversions only.

Converts a platform-native string into an equivalent byte string.

The returned string will use an unspecified encoding.

Examples

use std::ffi::OsStr;

use os_str_bytes::OsStrBytes;

let string = "foobar";
let os_string = OsStr::new(string);
assert_eq!(string.as_bytes(), &*os_string.to_raw_bytes());

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl OsStrBytes for OsStr

fn assert_from_raw_bytes<'a, S>(string: S) -> Cow<'a, Self>

where S: Into<Cow<'a, [u8]>>,

Available on crate feature conversions only.

fn from_io_bytes(string: &[u8]) -> Option<&Self>

fn from_raw_bytes<'a, S>(string: S) -> Result<Cow<'a, Self>, EncodingError>

where S: Into<Cow<'a, [u8]>>,

Available on crate feature checked_conversions only.

fn to_io_bytes(&self) -> Option<&[u8]>

fn to_io_bytes_lossy(&self) -> Cow<'_, [u8]>

fn to_raw_bytes(&self) -> Cow<'_, [u8]>

Available on crate feature conversions only.

impl OsStrBytes for Path

fn assert_from_raw_bytes<'a, S>(string: S) -> Cow<'a, Self>

where S: Into<Cow<'a, [u8]>>,

Available on crate feature conversions only.

fn from_io_bytes(string: &[u8]) -> Option<&Self>

fn from_raw_bytes<'a, S>(string: S) -> Result<Cow<'a, Self>, EncodingError>

where S: Into<Cow<'a, [u8]>>,

Available on crate feature checked_conversions only.

fn to_io_bytes(&self) -> Option<&[u8]>

fn to_io_bytes_lossy(&self) -> Cow<'_, [u8]>

fn to_raw_bytes(&self) -> Cow<'_, [u8]>

Available on crate feature conversions only.

Implementors