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.
impl OsStr[src]
pub fn new<S: AsRef<OsStr> + ?Sized>(s: &S) -> &OsStr[src]
Coerces into an OsStr slice.
use std::ffi::OsStr;
let os_str = OsStr::new("foo");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.
use std::ffi::OsStr;
let os_str = OsStr::new("foo");
assert_eq!(os_str.to_str(), Some("foo"));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.
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");
}pub fn to_os_string(&self) -> OsString[src]
Copies the slice into an owned OsString.
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"));pub fn is_empty(&self) -> bool[src]1.9.0
Checks whether the OsStr is empty.
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());pub fn len(&self) -> usize[src]1.9.0
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.
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);pub fn into_os_string(self: Box<OsStr>) -> OsString[src]1.20.0
pub fn make_ascii_lowercase(&mut self)[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.
#![feature(osstring_ascii)]
use std::ffi::OsString;
let mut s = OsString::from("GRÜßE, JÜRGEN ❤");
s.make_ascii_lowercase();
assert_eq!("grÜße, jÜrgen ❤", s);pub fn make_ascii_uppercase(&mut self)[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.
#![feature(osstring_ascii)]
use std::ffi::OsString;
let mut s = OsString::from("Grüße, Jürgen ❤");
s.make_ascii_uppercase();
assert_eq!("GRüßE, JüRGEN ❤", s);pub fn to_ascii_lowercase(&self) -> OsString[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.
#![feature(osstring_ascii)]
use std::ffi::OsString;
let s = OsString::from("Grüße, Jürgen ❤");
assert_eq!("grüße, jürgen ❤", s.to_ascii_lowercase());pub fn to_ascii_uppercase(&self) -> OsString[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.
#![feature(osstring_ascii)]
use std::ffi::OsString;
let s = OsString::from("Grüße, Jürgen ❤");
assert_eq!("GRüßE, JüRGEN ❤", s.to_ascii_uppercase());pub fn is_ascii(&self) -> bool[src]
Checks if all characters in this string are within the ASCII range.
#![feature(osstring_ascii)]
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());pub fn eq_ignore_ascii_case<S: ?Sized + AsRef<OsStr>>(&self, other: &S) -> bool[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.
#![feature(osstring_ascii)]
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"));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 Borrow<OsStr> for OsString[src]
impl Debug for OsStr[src]
impl<'_> Default for &'_ OsStr[src]1.9.0
impl Eq for OsStr[src]
impl<'_> From<&'_ OsStr> for Box<OsStr>[src]1.17.0
fn from(s: &OsStr) -> Box<OsStr>ⓘNotable traits for Box<F>
impl<F> Future for Box<F> where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
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>
[src]
impl<'_> From<&'_ OsStr> for Arc<OsStr>[src]1.24.0
impl<'_> From<&'_ OsStr> for Rc<OsStr>[src]1.24.0
impl<'a> From<&'a OsStr> for Cow<'a, OsStr>[src]1.28.0
impl Hash for OsStr[src]
fn hash<H: Hasher>(&self, state: &mut H)[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher, [src]1.3.0
impl Ord for OsStr[src]
fn cmp(&self, other: &OsStr) -> Ordering[src]
fn max(self, other: Self) -> Self[src]1.21.0
fn min(self, other: Self) -> Self[src]1.21.0
fn clamp(self, min: Self, max: Self) -> Self[src]
impl OsStrExt for OsStr[src]
fn from_bytes(slice: &[u8]) -> &OsStr[src]
fn as_bytes(&self) -> &[u8]ⓘNotable traits for &'_ [u8]
impl<'_> Read for &'_ [u8]
impl<'_> Write for &'_ mut [u8]
[src]
impl OsStrExt for OsStr[src]
fn encode_wide(&self) -> EncodeWide<'_>ⓘNotable traits for EncodeWide<'a>
impl<'a> Iterator for EncodeWide<'a>
type Item = u16;
[src]
impl<'a, 'b> PartialEq<&'a OsStr> for OsString[src]1.8.0
impl<'a, 'b> PartialEq<&'a OsStr> for PathBuf[src]1.8.0
impl<'a, 'b> PartialEq<&'a OsStr> for Path[src]1.8.0
impl<'a, 'b> PartialEq<&'a Path> for OsStr[src]1.8.0
impl<'a, 'b> PartialEq<&'b OsStr> for Cow<'a, OsStr>[src]1.8.0
impl<'a, 'b> PartialEq<&'b OsStr> for Cow<'a, Path>[src]1.8.0
impl<'a, 'b> PartialEq<Cow<'a, OsStr>> for OsStr[src]1.8.0
impl<'a, 'b> PartialEq<Cow<'a, OsStr>> for &'b OsStr[src]1.8.0
impl<'a, 'b> PartialEq<Cow<'a, Path>> for OsStr[src]1.8.0
impl<'a, 'b> PartialEq<Cow<'a, Path>> for &'b OsStr[src]1.8.0
impl PartialEq<OsStr> for OsStr[src]
impl PartialEq<OsStr> for str[src]
impl<'a, 'b> PartialEq<OsStr> for OsString[src]1.8.0
impl<'a, 'b> PartialEq<OsStr> for Cow<'a, OsStr>[src]1.8.0
impl<'a, 'b> PartialEq<OsStr> for PathBuf[src]1.8.0
impl<'a, 'b> PartialEq<OsStr> for Path[src]1.8.0
impl<'a, 'b> PartialEq<OsStr> for &'a Path[src]1.8.0
impl<'a, 'b> PartialEq<OsStr> for Cow<'a, Path>[src]1.8.0
impl<'a, 'b> PartialEq<OsString> for OsStr[src]1.8.0
impl<'a, 'b> PartialEq<OsString> for &'a OsStr[src]1.8.0
impl<'a, 'b> PartialEq<Path> for OsStr[src]1.8.0
impl<'a, 'b> PartialEq<Path> for &'a OsStr[src]1.8.0
impl<'a, 'b> PartialEq<PathBuf> for OsStr[src]1.8.0
impl<'a, 'b> PartialEq<PathBuf> for &'a OsStr[src]1.8.0
impl PartialEq<str> for OsStr[src]
impl<'a, 'b> PartialOrd<&'a OsStr> for OsString[src]1.8.0
fn partial_cmp(&self, other: &&'a OsStr) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<&'a OsStr> for PathBuf[src]1.8.0
fn partial_cmp(&self, other: &&'a OsStr) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<&'a OsStr> for Path[src]1.8.0
fn partial_cmp(&self, other: &&'a OsStr) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<&'a Path> for OsStr[src]1.8.0
fn partial_cmp(&self, other: &&'a Path) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<&'b OsStr> for Cow<'a, OsStr>[src]1.8.0
fn partial_cmp(&self, other: &&'b OsStr) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<&'b OsStr> for Cow<'a, Path>[src]1.8.0
fn partial_cmp(&self, other: &&'b OsStr) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<Cow<'a, OsStr>> for OsStr[src]1.8.0
fn partial_cmp(&self, other: &Cow<'a, OsStr>) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<Cow<'a, OsStr>> for &'b OsStr[src]1.8.0
fn partial_cmp(&self, other: &Cow<'a, OsStr>) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<Cow<'a, Path>> for OsStr[src]1.8.0
fn partial_cmp(&self, other: &Cow<'a, Path>) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<Cow<'a, Path>> for &'b OsStr[src]1.8.0
fn partial_cmp(&self, other: &Cow<'a, Path>) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl PartialOrd<OsStr> for OsStr[src]
fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>[src]
fn lt(&self, other: &OsStr) -> bool[src]
fn le(&self, other: &OsStr) -> bool[src]
fn gt(&self, other: &OsStr) -> bool[src]
fn ge(&self, other: &OsStr) -> bool[src]
impl<'a, 'b> PartialOrd<OsStr> for OsString[src]1.8.0
fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<OsStr> for Cow<'a, OsStr>[src]1.8.0
fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<OsStr> for PathBuf[src]1.8.0
fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<OsStr> for Path[src]1.8.0
fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<OsStr> for &'a Path[src]1.8.0
fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<OsStr> for Cow<'a, Path>[src]1.8.0
fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<OsString> for OsStr[src]1.8.0
fn partial_cmp(&self, other: &OsString) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<OsString> for &'a OsStr[src]1.8.0
fn partial_cmp(&self, other: &OsString) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<Path> for OsStr[src]1.8.0
fn partial_cmp(&self, other: &Path) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<Path> for &'a OsStr[src]1.8.0
fn partial_cmp(&self, other: &Path) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<PathBuf> for OsStr[src]1.8.0
fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl<'a, 'b> PartialOrd<PathBuf> for &'a OsStr[src]1.8.0
fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl PartialOrd<str> for OsStr[src]
fn partial_cmp(&self, other: &str) -> Option<Ordering>[src]
fn lt(&self, other: &Rhs) -> bool[src]
fn le(&self, other: &Rhs) -> bool[src]
fn gt(&self, other: &Rhs) -> bool[src]
fn ge(&self, other: &Rhs) -> bool[src]
impl ToOwned for OsStr[src]
impl RefUnwindSafe for OsStrimpl Send for OsStrimpl Sync for OsStrimpl Unpin for OsStrimpl UnwindSafe for OsStrimpl<T> Any for T where
T: 'static + ?Sized, [src]
impl<T> Borrow<T> for T where
T: ?Sized, [src]
fn borrow(&self) -> &TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
[src]
impl<T> ToOwned for T where
T: Clone, [src]
© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/ffi/struct.OsStr.html