1.0.0[][src]Struct std::ffi::OsStr

pub struct OsStr { /* fields omitted */ }

Borrowed reference to an OS string (see OsString).

This type represents a borrowed reference to a string in the operating system's preferred representation.

&OsStr is to OsString as &str is to String: the former in each pair are borrowed references; the latter are owned strings.

See the module's toplevel documentation about conversions for a discussion on the traits which OsStr implements for conversions from/to native representations.

Methods

impl OsStr[src]

pub fn new<S: AsRef<OsStr> + ?Sized>(s: &S) -> &OsStr[src]

Coerces into an OsStr slice.

Examples

use std::ffi::OsStr;

let os_str = OsStr::new("foo");Run

pub fn to_str(&self) -> Option<&str>[src]

Yields a &str slice if the OsStr is valid Unicode.

This conversion may entail doing a check for UTF-8 validity.

Examples

use std::ffi::OsStr;

let os_str = OsStr::new("foo");
assert_eq!(os_str.to_str(), Some("foo"));Run

pub fn to_string_lossy(&self) -> Cow<str>[src]

Converts an OsStr to a Cow<str>.

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

Examples

Calling to_string_lossy on an OsStr with invalid unicode:

// Note, due to differences in how Unix and Windows represent strings,
// we are forced to complicate this example, setting up example `OsStr`s
// with different source data and via different platform extensions.
// Understand that in reality you could end up with such example invalid
// sequences simply through collecting user command line arguments, for
// example.

#[cfg(any(unix, target_os = "redox"))] {
    use std::ffi::OsStr;
    use std::os::unix::ffi::OsStrExt;

    // Here, the values 0x66 and 0x6f correspond to 'f' and 'o'
    // respectively. The value 0x80 is a lone continuation byte, invalid
    // in a UTF-8 sequence.
    let source = [0x66, 0x6f, 0x80, 0x6f];
    let os_str = OsStr::from_bytes(&source[..]);

    assert_eq!(os_str.to_string_lossy(), "fo�o");
}
#[cfg(windows)] {
    use std::ffi::OsString;
    use std::os::windows::prelude::*;

    // Here the values 0x0066 and 0x006f correspond to 'f' and 'o'
    // respectively. The value 0xD800 is a lone surrogate half, invalid
    // in a UTF-16 sequence.
    let source = [0x0066, 0x006f, 0xD800, 0x006f];
    let os_string = OsString::from_wide(&source[..]);
    let os_str = os_string.as_os_str();

    assert_eq!(os_str.to_string_lossy(), "fo�o");
}Run

pub fn to_os_string(&self) -> OsString[src]

Copies the slice into an owned OsString.

Examples

use std::ffi::{OsStr, OsString};

let os_str = OsStr::new("foo");
let os_string = os_str.to_os_string();
assert_eq!(os_string, OsString::from("foo"));Run

pub fn is_empty(&self) -> bool1.9.0[src]

Checks whether the OsStr is empty.

Examples

use std::ffi::OsStr;

let os_str = OsStr::new("");
assert!(os_str.is_empty());

let os_str = OsStr::new("foo");
assert!(!os_str.is_empty());Run

pub fn len(&self) -> usize1.9.0[src]

Returns the length of this OsStr.

Note that this does not return the number of bytes in the string in OS string form.

The length returned is that of the underlying storage used by OsStr. As discussed in the OsString introduction, OsString and OsStr store strings in a form best suited for cheap inter-conversion between native-platform and Rust string forms, which may differ significantly from both of them, including in storage size and encoding.

This number is simply useful for passing to other methods, like OsString::with_capacity to avoid reallocations.

Examples

use std::ffi::OsStr;

let os_str = OsStr::new("");
assert_eq!(os_str.len(), 0);

let os_str = OsStr::new("foo");
assert_eq!(os_str.len(), 3);Run

pub fn into_os_string(self: Box<OsStr>) -> OsString1.20.0[src]

Converts a Box<OsStr> into an OsString without copying or allocating.

Trait Implementations

impl OsStrExt for OsStr[src]

impl OsStrExt for OsStr[src]

impl<'_> From<&'_ OsStr> for Box<OsStr>1.17.0[src]

impl<'_> From<&'_ OsStr> for Arc<OsStr>1.24.0[src]

impl<'_> From<&'_ OsStr> for Rc<OsStr>1.24.0[src]

impl<'a> From<&'a OsStr> for Cow<'a, OsStr>1.28.0[src]

impl Debug for OsStr[src]

impl PartialEq<OsStr> for OsStr[src]

impl PartialEq<str> for OsStr[src]

impl PartialEq<OsStr> for str[src]

impl<'a, 'b> PartialEq<OsStr> for OsString1.8.0[src]

impl<'a, 'b> PartialEq<OsString> for OsStr1.8.0[src]

impl<'a, 'b> PartialEq<&'a OsStr> for OsString1.8.0[src]

impl<'a, 'b> PartialEq<OsString> for &'a OsStr1.8.0[src]

impl<'a, 'b> PartialEq<OsStr> for Cow<'a, OsStr>1.8.0[src]

impl<'a, 'b> PartialEq<Cow<'a, OsStr>> for OsStr1.8.0[src]

impl<'a, 'b> PartialEq<&'b OsStr> for Cow<'a, OsStr>1.8.0[src]

impl<'a, 'b> PartialEq<Cow<'a, OsStr>> for &'b OsStr1.8.0[src]

impl<'a, 'b> PartialEq<OsStr> for PathBuf1.8.0[src]

impl<'a, 'b> PartialEq<PathBuf> for OsStr1.8.0[src]

impl<'a, 'b> PartialEq<&'a OsStr> for PathBuf1.8.0[src]

impl<'a, 'b> PartialEq<PathBuf> for &'a OsStr1.8.0[src]

impl<'a, 'b> PartialEq<OsStr> for Path1.8.0[src]

impl<'a, 'b> PartialEq<Path> for OsStr1.8.0[src]

impl<'a, 'b> PartialEq<&'a OsStr> for Path1.8.0[src]

impl<'a, 'b> PartialEq<Path> for &'a OsStr1.8.0[src]

impl<'a, 'b> PartialEq<OsStr> for &'a Path1.8.0[src]

impl<'a, 'b> PartialEq<&'a Path> for OsStr1.8.0[src]

impl<'a, 'b> PartialEq<OsStr> for Cow<'a, Path>1.8.0[src]

impl<'a, 'b> PartialEq<Cow<'a, Path>> for OsStr1.8.0[src]

impl<'a, 'b> PartialEq<&'b OsStr> for Cow<'a, Path>1.8.0[src]

impl<'a, 'b> PartialEq<Cow<'a, Path>> for &'b OsStr1.8.0[src]

impl Eq for OsStr[src]

impl Ord for OsStr[src]

impl PartialOrd<OsStr> for OsStr[src]

impl PartialOrd<str> for OsStr[src]

impl<'a, 'b> PartialOrd<OsStr> for OsString1.8.0[src]

impl<'a, 'b> PartialOrd<OsString> for OsStr1.8.0[src]

impl<'a, 'b> PartialOrd<&'a OsStr> for OsString1.8.0[src]

impl<'a, 'b> PartialOrd<OsString> for &'a OsStr1.8.0[src]

impl<'a, 'b> PartialOrd<OsStr> for Cow<'a, OsStr>1.8.0[src]

impl<'a, 'b> PartialOrd<Cow<'a, OsStr>> for OsStr1.8.0[src]

impl<'a, 'b> PartialOrd<&'b OsStr> for Cow<'a, OsStr>1.8.0[src]

impl<'a, 'b> PartialOrd<Cow<'a, OsStr>> for &'b OsStr1.8.0[src]

impl<'a, 'b> PartialOrd<OsStr> for PathBuf1.8.0[src]

impl<'a, 'b> PartialOrd<PathBuf> for OsStr1.8.0[src]

impl<'a, 'b> PartialOrd<&'a OsStr> for PathBuf1.8.0[src]

impl<'a, 'b> PartialOrd<PathBuf> for &'a OsStr1.8.0[src]

impl<'a, 'b> PartialOrd<OsStr> for Path1.8.0[src]

impl<'a, 'b> PartialOrd<Path> for OsStr1.8.0[src]

impl<'a, 'b> PartialOrd<&'a OsStr> for Path1.8.0[src]

impl<'a, 'b> PartialOrd<Path> for &'a OsStr1.8.0[src]

impl<'a, 'b> PartialOrd<OsStr> for &'a Path1.8.0[src]

impl<'a, 'b> PartialOrd<&'a Path> for OsStr1.8.0[src]

impl<'a, 'b> PartialOrd<OsStr> for Cow<'a, Path>1.8.0[src]

impl<'a, 'b> PartialOrd<Cow<'a, Path>> for OsStr1.8.0[src]

impl<'a, 'b> PartialOrd<&'b OsStr> for Cow<'a, Path>1.8.0[src]

impl<'a, 'b> PartialOrd<Cow<'a, Path>> for &'b OsStr1.8.0[src]

impl Hash for OsStr[src]

impl AsRef<OsStr> for OsStr[src]

impl AsRef<OsStr> for OsString[src]

impl AsRef<OsStr> for str[src]

impl AsRef<OsStr> for String[src]

impl<'_> AsRef<OsStr> for Component<'_>[src]

impl<'_> AsRef<OsStr> for Components<'_>[src]

impl<'_> AsRef<OsStr> for Iter<'_>[src]

impl AsRef<OsStr> for PathBuf[src]

impl AsRef<OsStr> for Path[src]

impl AsRef<Path> for OsStr[src]

impl<'_> Default for &'_ OsStr1.9.0[src]

fn default() -> Self[src]

Creates an empty OsStr.

impl Borrow<OsStr> for OsString[src]

impl ToOwned for OsStr[src]

type Owned = OsString

The resulting type after obtaining ownership.

Auto Trait Implementations

impl UnwindSafe for OsStr

impl RefUnwindSafe for OsStr

impl Unpin for OsStr

impl Send for OsStr

impl Sync for OsStr

Blanket Implementations

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.