Struct std::ffi::OsStr1.0.0[−][src]

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.

Implementations

`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.

`pub fn make_ascii_lowercase(&mut self)`1.53.0 [src]

Converts this string to its ASCII lower case equivalent in-place.

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

To return a new lowercased value without modifying the existing one, use OsStr::to_ascii_lowercase.

Examples

use std::ffi::OsString;

let mut s = OsString::from("GRÜßE, JÜRGEN ❤");

s.make_ascii_lowercase();

assert_eq!("grÜße, jÜrgen ❤", s);

Run

`pub fn make_ascii_uppercase(&mut self)`1.53.0 [src]

Converts this string to its ASCII upper case equivalent in-place.

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

To return a new uppercased value without modifying the existing one, use OsStr::to_ascii_uppercase.

Examples

use std::ffi::OsString;

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

s.make_ascii_uppercase();

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

Run

`pub fn to_ascii_lowercase(&self) -> OsString`1.53.0 [src]

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

Run

`pub fn to_ascii_uppercase(&self) -> OsString`1.53.0 [src]

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

Run

`pub fn is_ascii(&self) -> bool`1.53.0 [src]

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

Run

`pub fn eq_ignore_ascii_case<S: AsRef<OsStr>>(&self, other: S) -> bool`1.53.0 [src]

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

Run

Trait Implementations

`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 AsRef<OsStr> for Component<'_>`[src]

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

Performs the conversion.

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

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

Performs the conversion.

`impl AsRef<OsStr> for Iter<'_>`[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 Borrow<OsStr> for OsString`[src]

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

Immutably borrows from an owned value. Read more

`impl Debug for OsStr`[src]

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

Formats the value using the given formatter. Read more

`impl Default for &OsStr`1.9.0[src]

`fn default() -> Self`[src]

Creates an empty OsStr.

`impl<'a> Extend<&'a OsStr> for OsString`1.52.0[src]

`fn extend<T: IntoIterator<Item = &'a OsStr>>(&mut self, iter: T)`[src]

Extends a collection with the contents of an iterator. Read more

`fn extend_one(&mut self, item: A)`[src]

🔬 This is a nightly-only experimental API. (extend_one #72631)

Extends a collection with exactly one element.

`fn extend_reserve(&mut self, additional: usize)`[src]

🔬 This is a nightly-only experimental API. (extend_one #72631)

Reserves capacity in a collection for the given number of additional elements. Read more

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

`fn from(s: &OsStr) -> Box<OsStr>ⓘNotable traits for Box<F, A> impl<F, A> Future for Box<F, A> where F: Future + Unpin + ?Sized, A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where I: Iterator + ?Sized, A: Allocator, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`[src]

Performs the conversion.

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

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

Performs the conversion.

`impl From<&'_ 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<'a> FromIterator<&'a OsStr> for OsString`1.52.0[src]

`fn from_iter<I: IntoIterator<Item = &'a OsStr>>(iter: I) -> Self`[src]

Creates a value from an iterator. 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 Ord for OsStr`[src]

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

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

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

Compares and returns the maximum of two values. Read more

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

Compares and returns the minimum of two values. Read more

`#[must_use] fn clamp(self, min: Self, max: Self) -> Self`1.50.0 [src]

Restrict a value to a certain interval. Read more

`impl OsStrExt for OsStr`[src]

This is supported on Windows only.

`fn encode_wide(&self) -> EncodeWide<'_>ⓘNotable traits for EncodeWide<'a> impl<'a> Iterator for EncodeWide<'a> type Item = u16;`[src]

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

`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

`fn as_bytes(&self) -> &[u8]ⓘNotable traits for &[u8] impl Read for &[u8]impl Write for &mut [u8]`[src]

This is supported on Unix only.

Gets the underlying byte view of the OsStr slice. Read more