# Struct clap::builder::OsStr

source · [−]

    pub struct OsStr { /* private fields */ }

Expand description

A UTF-8-encoded fixed string

NOTE: To support dynamic values (i.e. `OsString`), enable the [`string` feature][crate::_features]

## Implementations

source

### impl OsStr

source

#### pub fn as_os_str(&self) -> &OsStr

Get the raw string as an `std::ffi::OsStr`

source

#### pub fn to_os_string(&self) -> OsString

Get the raw string as an `OsString`

## Methods from Deref<Target = OsStr>

1.0.0 · source

#### pub fn to_str(&self) -> Option<&str>

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"));

1.0.0 · source

#### pub fn to_string_lossy(&self) -> Cow<'_, str>

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(unix)] {
        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");
    }

1.0.0 · source

#### pub fn to_os_string(&self) -> OsString

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"));

1.9.0 · source

#### pub fn is_empty(&self) -> bool

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());

1.9.0 · source

#### pub fn len(&self) -> usize

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.

See the main `OsString` documentation information about encoding and capacity units.

##### 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);

1.53.0 · source

#### pub fn to_ascii_lowercase(&self) -> OsString

Returns a copy of this string where each character is mapped to its ASCII lower case equivalent.

ASCII letters ‘A’ to ‘Z’ are mapped to ‘a’ to ‘z’, but non-ASCII letters are unchanged.

To lowercase the value in-place, use `OsStr::make_ascii_lowercase`.

##### Examples

    use std::ffi::OsString;
    let s = OsString::from("Grüße, Jürgen ❤");

    assert_eq!("grüße, jürgen ❤", s.to_ascii_lowercase());

1.53.0 · source

#### pub fn to_ascii_uppercase(&self) -> OsString

Returns a copy of this string where each character is mapped to its ASCII upper case equivalent.

ASCII letters ‘a’ to ‘z’ are mapped to ‘A’ to ‘Z’, but non-ASCII letters are unchanged.

To uppercase the value in-place, use `OsStr::make_ascii_uppercase`.

##### Examples

    use std::ffi::OsString;
    let s = OsString::from("Grüße, Jürgen ❤");

    assert_eq!("GRüßE, JüRGEN ❤", s.to_ascii_uppercase());

1.53.0 · source

#### pub fn is_ascii(&self) -> bool

Checks if all characters in this string are within the ASCII range.

##### Examples

    use std::ffi::OsString;

    let ascii = OsString::from("hello!\n");
    let non_ascii = OsString::from("Grüße, Jürgen ❤");

    assert!(ascii.is_ascii());
    assert!(!non_ascii.is_ascii());

1.53.0 · source

#### pub fn eq_ignore_ascii_case<S>(&self, other: S) -> bool where
S: AsRef<OsStr>,

Checks that two strings are an ASCII case-insensitive match.

Same as `to_ascii_lowercase(a) == to_ascii_lowercase(b)`, but without allocating and copying temporaries.

##### Examples

    use std::ffi::OsString;

    assert!(OsString::from("Ferris").eq_ignore_ascii_case("FERRIS"));
    assert!(OsString::from("Ferrös").eq_ignore_ascii_case("FERRöS"));
    assert!(!OsString::from("Ferrös").eq_ignore_ascii_case("FERRÖS"));

## Trait Implementations

source

### impl AsRef<OsStr> for OsStr

source

#### fn as_ref(&self) -> &OsStr

Converts this type into a shared reference of the (usually inferred) input type.

source

### impl AsRef<Path> for OsStr

source

#### fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

source

### impl Borrow<OsStr> for OsStr

source

#### fn borrow(&self) -> &OsStr

Immutably borrows from an owned value. Read more

source

### impl Clone for OsStr

source

#### fn clone(&self) -> OsStr

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from `source`. Read more

source

### impl Debug for OsStr

source

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

Formats the value using the given formatter. Read more

source

### impl Default for OsStr

source

#### fn default() -> OsStr

Returns the “default value” for a type. Read more

source

### impl Deref for OsStr

#### type Target = OsStr

The resulting type after dereferencing.

source

#### fn deref(&self) -> &OsStr

Dereferences the value.

source

### impl From<&&'static OsStr> for OsStr

source

#### fn from(name: &&'static OsStr) -> Self

Converts to this type from the input type.

source

### impl From<&&'static str> for OsStr

source

#### fn from(name: &&'static str) -> Self

Converts to this type from the input type.

source

### impl From<&'static OsStr> for OsStr

source

#### fn from(name: &'static OsStr) -> Self

Converts to this type from the input type.

source

### impl From<&'static str> for OsStr

source

#### fn from(name: &'static str) -> Self

Converts to this type from the input type.

source

### impl From<&OsStr> for OsStr

source

#### fn from(id: &OsStr) -> Self

Converts to this type from the input type.

source

### impl From<&Str> for OsStr

source

#### fn from(id: &Str) -> Self

Converts to this type from the input type.

source

### impl From<OsStr> for OsString

source

#### fn from(name: OsStr) -> Self

Converts to this type from the input type.

source

### impl From<OsStr> for PathBuf

source

#### fn from(name: OsStr) -> Self

Converts to this type from the input type.

source

### impl From<Str> for OsStr

source

#### fn from(id: Str) -> Self

Converts to this type from the input type.

source

### impl Hash for OsStr

source

#### fn hash<__H: Hasher>(&self, state: &mut __H)

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

1.3.0 · source

#### fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

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

source

### impl<I: Into<OsStr>> IntoResettable<OsStr> for I

source

#### fn into_resettable(self) -> Resettable<OsStr>

Convert to the intended resettable type

source

### impl IntoResettable<OsStr> for Option<&'static str>

source

#### fn into_resettable(self) -> Resettable<OsStr>

Convert to the intended resettable type

source

### impl Ord for OsStr

source

#### fn cmp(&self, other: &OsStr) -> Ordering

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

1.21.0 · source

#### fn max(self, other: Self) -> Self

Compares and returns the maximum of two values. Read more

1.21.0 · source

#### fn min(self, other: Self) -> Self

Compares and returns the minimum of two values. Read more

1.50.0 · source

#### fn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,

Restrict a value to a certain interval. Read more

source

### impl PartialEq<&OsStr> for OsStr

source

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

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

1.0.0 · source

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

This method tests for `!=`.

source

### impl PartialEq<&str> for OsStr

source

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

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

1.0.0 · source

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

This method tests for `!=`.

source

### impl PartialEq<OsStr> for &OsStr

source

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

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

1.0.0 · source

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

This method tests for `!=`.

source

### impl PartialEq<OsStr> for &str

source

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

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

1.0.0 · source

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

This method tests for `!=`.

source

### impl PartialEq<OsStr> for OsStr

source

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

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

source

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

This method tests for `!=`.

source

### impl PartialEq<OsStr> for OsString

source

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

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

1.0.0 · source

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

This method tests for `!=`.

source

### impl PartialEq<OsStr> for String

source

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

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

1.0.0 · source

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

This method tests for `!=`.

source

### impl PartialEq<OsStr> for str

source

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

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

1.0.0 · source

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

This method tests for `!=`.

source

### impl PartialEq<OsString> for OsStr

source

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

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

1.0.0 · source

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

This method tests for `!=`.

source

### impl PartialEq<String> for OsStr

source

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

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

1.0.0 · source

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

This method tests for `!=`.

source

### impl PartialEq<str> for OsStr

source

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

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

1.0.0 · source

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

This method tests for `!=`.

source

### impl PartialOrd<OsStr> for OsStr

source

#### fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

### impl Eq for OsStr

source

### impl StructuralEq for OsStr

source

### impl StructuralPartialEq for OsStr

## Auto Trait Implementations

### impl RefUnwindSafe for OsStr

### impl Send for OsStr

### impl Sync for OsStr

### impl Unpin for OsStr

### impl UnwindSafe for OsStr

## Blanket Implementations

source

### impl<T> Any for T where
T: 'static + ?Sized,

source

#### fn type_id(&self) -> TypeId

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

source

### impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

### impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

### impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source

### impl<T> ToOwned for T where
T: Clone,

#### type Owned = T

The resulting type after obtaining ownership.

source

#### fn to_owned(&self) -> T

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

source

#### fn clone_into(&self, target: &mut T)

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

source

### impl<T, U> TryFrom<U> for T where
U: Into<T>,

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

source

### impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.