# 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) -> bool` | 1.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) -> usize` | 1.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>) -> OsString` | 1.20.0 [src]

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

## Trait Implementations

###

`impl OsStrExt for OsStr` | [src]

####

`fn from_bytes(slice: &[u8]) -> &OsStr` | [src]

This is supported on Unix only.

Creates an [`OsStr`] from a byte slice. Read more

####
ⓘImportant traits for &'a [u8]

### Important traits for &'a [u8]

`impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]`

`fn as_bytes(&self) -> &[u8]` | [src]

This is supported on Unix only.

Gets the underlying byte view of the [`OsStr`] slice. Read more

###

`impl OsStrExt for OsStr` | [src]

####
ⓘImportant traits for EncodeWide<'a>

### Important traits for EncodeWide<'a>

`impl<'a> Iterator for EncodeWide<'a> type Item = u16;`

`fn encode_wide(&self) -> EncodeWide` | [src]

This is supported on Windows only.

Re-encodes an `OsStr` as a wide character sequence, i.e., potentially ill-formed UTF-16. Read more

###

`impl<'a> From<&'a OsStr> for Box<OsStr>` | 1.17.0 [src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`

`fn from(s: &'a OsStr) -> Box<OsStr>` | [src]

Performs the conversion.

###

`impl<'a> From<&'a OsStr> for Arc<OsStr>` | 1.24.0 [src]

####

`fn from(s: &OsStr) -> Arc<OsStr>` | [src]

Performs the conversion.

###

`impl<'a> From<&'a OsStr> for Rc<OsStr>` | 1.24.0 [src]

####

`fn from(s: &OsStr) -> Rc<OsStr>` | [src]

Performs the conversion.

###

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

####

`fn from(s: &'a OsStr) -> Cow<'a, OsStr>` | [src]

Performs the conversion.

###

`impl Debug for OsStr` | [src]

####

`fn fmt(&self, formatter: &mut Formatter) -> Result` | [src]

Formats the value using the given formatter. Read more

###

`impl PartialEq<OsStr> for OsStr` | [src]

####

`fn eq(&self, other: &OsStr) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

`impl PartialEq<str> for OsStr` | [src]

####

`fn eq(&self, other: &str) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

`impl PartialEq<OsStr> for str` | [src]

####

`fn eq(&self, other: &OsStr) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

`impl<'a, 'b> PartialEq<OsStr> for OsString` | 1.8.0 [src]

####

`fn eq(&self, other: &OsStr) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

`impl<'a, 'b> PartialEq<OsString> for OsStr` | 1.8.0 [src]

####

`fn eq(&self, other: &OsString) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

`impl<'a, 'b> PartialEq<&'a OsStr> for OsString` | 1.8.0 [src]

####

`fn eq(&self, other: &&'a OsStr) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

`impl<'a, 'b> PartialEq<OsString> for &'a OsStr` | 1.8.0 [src]

####

`fn eq(&self, other: &OsString) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

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

####

`fn eq(&self, other: &OsStr) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

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

####

`fn eq(&self, other: &Cow<'a, OsStr>) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

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

####

`fn eq(&self, other: &&'b OsStr) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

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

####

`fn eq(&self, other: &Cow<'a, OsStr>) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

`impl<'a, 'b> PartialEq<OsStr> for PathBuf` | 1.8.0 [src]

####

`fn eq(&self, other: &OsStr) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

`impl<'a, 'b> PartialEq<PathBuf> for OsStr` | 1.8.0 [src]

####

`fn eq(&self, other: &PathBuf) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

`impl<'a, 'b> PartialEq<&'a OsStr> for PathBuf` | 1.8.0 [src]

####

`fn eq(&self, other: &&'a OsStr) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

`impl<'a, 'b> PartialEq<PathBuf> for &'a OsStr` | 1.8.0 [src]

####

`fn eq(&self, other: &PathBuf) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

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

####

`fn eq(&self, other: &OsStr) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

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

####

`fn eq(&self, other: &Path) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

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

####

`fn eq(&self, other: &&'a OsStr) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

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

####

`fn eq(&self, other: &Path) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

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

####

`fn eq(&self, other: &OsStr) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

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

####

`fn eq(&self, other: &&'a Path) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

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

####

`fn eq(&self, other: &OsStr) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

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

####

`fn eq(&self, other: &Cow<'a, Path>) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

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

####

`fn eq(&self, other: &&'b OsStr) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

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

####

`fn eq(&self, other: &Cow<'a, Path>) -> bool` | [src]

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

####

`#[must_use] fn ne(&self, other: &Rhs) -> bool` | [src]

This method tests for `!=`.

###

`impl Eq for OsStr` | [src]

###

`impl Ord for OsStr` | [src]

####

`fn cmp(&self, other: &OsStr) -> Ordering` | [src]

This method returns an `Ordering` between `self` and `other`. Read more

####

`fn max(self, other: Self) -> Self` | 1.21.0 [src]

Compares and returns the maximum of two values. Read more

####

`fn min(self, other: Self) -> Self` | 1.21.0 [src]

Compares and returns the minimum of two values. Read more

###

`impl PartialOrd<OsStr> for OsStr` | [src]

####

`fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`fn lt(&self, other: &OsStr) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`fn le(&self, other: &OsStr) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`fn gt(&self, other: &OsStr) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`fn ge(&self, other: &OsStr) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

`impl PartialOrd<str> for OsStr` | [src]

####

`fn partial_cmp(&self, other: &str) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

`impl<'a, 'b> PartialOrd<OsStr> for OsString` | 1.8.0 [src]

####

`fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

`impl<'a, 'b> PartialOrd<OsString> for OsStr` | 1.8.0 [src]

####

`fn partial_cmp(&self, other: &OsString) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

`impl<'a, 'b> PartialOrd<&'a OsStr> for OsString` | 1.8.0 [src]

####

`fn partial_cmp(&self, other: &&'a OsStr) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

`impl<'a, 'b> PartialOrd<OsString> for &'a OsStr` | 1.8.0 [src]

####

`fn partial_cmp(&self, other: &OsString) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

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

####

`fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

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

####

`fn partial_cmp(&self, other: &Cow<'a, OsStr>) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

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

####

`fn partial_cmp(&self, other: &&'b OsStr) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

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

####

`fn partial_cmp(&self, other: &Cow<'a, OsStr>) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

`impl<'a, 'b> PartialOrd<OsStr> for PathBuf` | 1.8.0 [src]

####

`fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

`impl<'a, 'b> PartialOrd<PathBuf> for OsStr` | 1.8.0 [src]

####

`fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

`impl<'a, 'b> PartialOrd<&'a OsStr> for PathBuf` | 1.8.0 [src]

####

`fn partial_cmp(&self, other: &&'a OsStr) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

`impl<'a, 'b> PartialOrd<PathBuf> for &'a OsStr` | 1.8.0 [src]

####

`fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

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

####

`fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

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

####

`fn partial_cmp(&self, other: &Path) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

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

####

`fn partial_cmp(&self, other: &&'a OsStr) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

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

####

`fn partial_cmp(&self, other: &Path) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

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

####

`fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

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

####

`fn partial_cmp(&self, other: &&'a Path) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

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

####

`fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

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

####

`fn partial_cmp(&self, other: &Cow<'a, Path>) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

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

####

`fn partial_cmp(&self, other: &&'b OsStr) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

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

####

`fn partial_cmp(&self, other: &Cow<'a, Path>) -> Option<Ordering>` | [src]

This method returns an ordering between `self` and `other` values if one exists. Read more

####

`#[must_use] fn lt(&self, other: &Rhs) -> bool` | [src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

####

`#[must_use] fn le(&self, other: &Rhs) -> bool` | [src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

####

`#[must_use] fn gt(&self, other: &Rhs) -> bool` | [src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

####

`#[must_use] fn ge(&self, other: &Rhs) -> bool` | [src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

###

`impl Hash for OsStr` | [src]

####

`fn hash<H: Hasher>(&self, state: &mut H)` | [src]

Feeds this value into the given [`Hasher`]. Read more

####

`fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,` | 1.3.0 [src]

Feeds a slice of this type into the given [`Hasher`]. Read more

###

`impl AsRef<OsStr> for OsStr` | [src]

####

`fn as_ref(&self) -> &OsStr` | [src]

Performs the conversion.

###

`impl AsRef<OsStr> for OsString` | [src]

####

`fn as_ref(&self) -> &OsStr` | [src]

Performs the conversion.

###

`impl AsRef<OsStr> for str` | [src]

####

`fn as_ref(&self) -> &OsStr` | [src]

Performs the conversion.

###

`impl AsRef<OsStr> for String` | [src]

####

`fn as_ref(&self) -> &OsStr` | [src]

Performs the conversion.

###

`impl<'a> AsRef<OsStr> for Component<'a>` | [src]

####

`fn as_ref(&self) -> &OsStr` | [src]

Performs the conversion.

###

`impl<'a> AsRef<OsStr> for Components<'a>` | [src]

####

`fn as_ref(&self) -> &OsStr` | [src]

Performs the conversion.

###

`impl<'a> AsRef<OsStr> for Iter<'a>` | [src]

####

`fn as_ref(&self) -> &OsStr` | [src]

Performs the conversion.

###

`impl AsRef<OsStr> for PathBuf` | [src]

####

`fn as_ref(&self) -> &OsStr` | [src]

Performs the conversion.

###

`impl AsRef<OsStr> for Path` | [src]

####

`fn as_ref(&self) -> &OsStr` | [src]

Performs the conversion.

###

`impl AsRef<Path> for OsStr` | [src]

####

`fn as_ref(&self) -> &Path` | [src]

Performs the conversion.

###

`impl<'a> Default for &'a OsStr` | 1.9.0 [src]

####

`fn default() -> &'a OsStr` | [src]

Creates an empty `OsStr`.

###

`impl Borrow<OsStr> for OsString` | [src]

####

`fn borrow(&self) -> &OsStr` | [src]

Immutably borrows from an owned value. Read more

###

`impl ToOwned for OsStr` | [src]

#### `type Owned = OsString`

####

`fn to_owned(&self) -> OsString` | [src]

Creates owned data from borrowed data, usually by cloning. Read more

####

`fn clone_into(&self, target: &mut OsString)` | [src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

## Auto Trait Implementations

###

`impl Send for OsStr` |

###

`impl Sync for OsStr` |

## Blanket Implementations

###

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

####
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`fn borrow(&self) -> &T` | [src]

Immutably borrows from an owned value. Read more

###

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

####
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`fn borrow_mut(&mut self) -> &mut T` | [src]

Mutably borrows from an owned value. Read more

###

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

####

`fn get_type_id(&self) -> TypeId` | [src]

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

Gets the `TypeId` of `self`. Read more

###

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

#### `type Owned = T`

####

`fn to_owned(&self) -> T` | [src]

Creates owned data from borrowed data, usually by cloning. Read more

####

`fn clone_into(&self, target: &mut T)` | [src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)