1.0.0[−][src]Struct std::ffi::OsStr
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>(s: &S) -> &OsStr where
S: AsRef<OsStr> + ?Sized,
[src]
S: AsRef<OsStr> + ?Sized,
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"));
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"); }
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"));
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());
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);
pub fn into_os_string(self: Box<OsStr>) -> OsString
1.20.0[src]
Trait Implementations
impl<'_> From<&'_ OsStr> for Rc<OsStr>
1.24.0[src]
impl<'_> From<&'_ OsStr> for Box<OsStr>
1.17.0[src]
impl<'_> From<&'_ OsStr> for Arc<OsStr>
1.24.0[src]
impl<'a> From<&'a OsStr> for Cow<'a, OsStr>
1.28.0[src]
impl Eq for OsStr
[src]
impl<'_> AsRef<OsStr> for Iter<'_>
[src]
impl AsRef<OsStr> for OsString
[src]
impl AsRef<Path> for OsStr
[src]
impl AsRef<OsStr> for Path
[src]
impl<'_> AsRef<OsStr> for Component<'_>
[src]
impl AsRef<OsStr> for OsStr
[src]
impl AsRef<OsStr> for PathBuf
[src]
impl AsRef<OsStr> for str
[src]
impl AsRef<OsStr> for String
[src]
impl<'_> AsRef<OsStr> for Components<'_>
[src]
impl<'_> Default for &'_ OsStr
1.9.0[src]
impl<'a, 'b> PartialEq<OsStr> for &'a Path
1.8.0[src]
impl<'a, 'b> PartialEq<Path> for &'a OsStr
1.8.0[src]
impl<'a, 'b> PartialEq<&'a OsStr> for Path
1.8.0[src]
impl<'a, 'b> PartialEq<&'a OsStr> for PathBuf
1.8.0[src]
impl<'a, 'b> PartialEq<&'a OsStr> for OsString
1.8.0[src]
impl<'a, 'b> PartialEq<Cow<'a, Path>> for OsStr
1.8.0[src]
impl<'a, 'b> PartialEq<OsStr> for Cow<'a, Path>
1.8.0[src]
impl PartialEq<str> for OsStr
[src]
impl<'a, 'b> PartialEq<OsStr> for PathBuf
1.8.0[src]
impl PartialEq<OsStr> for str
[src]
impl<'a, 'b> PartialEq<OsString> for OsStr
1.8.0[src]
impl<'a, 'b> PartialEq<OsStr> for Cow<'a, OsStr>
1.8.0[src]
impl<'a, 'b> PartialEq<&'a Path> for OsStr
1.8.0[src]
impl PartialEq<OsStr> for OsStr
[src]
impl<'a, 'b> PartialEq<Path> for OsStr
1.8.0[src]
impl<'a, 'b> PartialEq<Cow<'a, OsStr>> for &'b OsStr
1.8.0[src]
impl<'a, 'b> PartialEq<OsStr> for Path
1.8.0[src]
impl<'a, 'b> PartialEq<Cow<'a, Path>> for &'b OsStr
1.8.0[src]
impl<'a, 'b> PartialEq<&'b OsStr> for Cow<'a, Path>
1.8.0[src]
impl<'a, 'b> PartialEq<PathBuf> for OsStr
1.8.0[src]
impl<'a, 'b> PartialEq<PathBuf> for &'a OsStr
1.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 OsStr
1.8.0[src]
impl<'a, 'b> PartialEq<OsString> for &'a OsStr
1.8.0[src]
impl<'a, 'b> PartialEq<OsStr> for OsString
1.8.0[src]
impl Hash for OsStr
[src]
fn hash<H>(&self, state: &mut H) where
H: Hasher,
[src]
H: Hasher,
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl Borrow<OsStr> for OsString
[src]
impl OsStrExt for OsStr
[src]
impl ToOwned for OsStr
[src]
type Owned = OsString
The resulting type after obtaining ownership.
fn to_owned(&self) -> OsString
[src]
fn clone_into(&self, target: &mut OsString)
[src]
impl Ord for OsStr
[src]
fn cmp(&self, other: &OsStr) -> Ordering
[src]
fn max(self, other: Self) -> Self
1.21.0[src]
fn min(self, other: Self) -> Self
1.21.0[src]
fn clamp(self, min: Self, max: Self) -> Self
[src]
impl<'a, 'b> PartialOrd<&'a Path> for OsStr
1.8.0[src]
fn partial_cmp(&self, other: &&'a Path) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl<'a, 'b> PartialOrd<Path> for &'a OsStr
1.8.0[src]
fn partial_cmp(&self, other: &Path) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl<'a, 'b> PartialOrd<PathBuf> for &'a OsStr
1.8.0[src]
fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
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<&'b OsStr> for Cow<'a, Path>
1.8.0[src]
fn partial_cmp(&self, other: &&'b OsStr) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl<'a, 'b> PartialOrd<&'a OsStr> for Path
1.8.0[src]
fn partial_cmp(&self, other: &&'a OsStr) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
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]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl PartialOrd<str> for OsStr
[src]
fn partial_cmp(&self, other: &str) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl<'a, 'b> PartialOrd<&'b OsStr> for Cow<'a, OsStr>
1.8.0[src]
fn partial_cmp(&self, other: &&'b OsStr) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl<'a, 'b> PartialOrd<OsStr> for Cow<'a, Path>
1.8.0[src]
fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl<'a, 'b> PartialOrd<OsStr> for Cow<'a, OsStr>
1.8.0[src]
fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl<'a, 'b> PartialOrd<OsString> for OsStr
1.8.0[src]
fn partial_cmp(&self, other: &OsString) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl<'a, 'b> PartialOrd<Cow<'a, OsStr>> for OsStr
1.8.0[src]
fn partial_cmp(&self, other: &Cow<'a, OsStr>) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl<'a, 'b> PartialOrd<OsStr> for &'a Path
1.8.0[src]
fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl<'a, 'b> PartialOrd<&'a OsStr> for PathBuf
1.8.0[src]
fn partial_cmp(&self, other: &&'a OsStr) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl<'a, 'b> PartialOrd<Path> for OsStr
1.8.0[src]
fn partial_cmp(&self, other: &Path) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl<'a, 'b> PartialOrd<OsStr> for OsString
1.8.0[src]
fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl<'a, 'b> PartialOrd<Cow<'a, Path>> for OsStr
1.8.0[src]
fn partial_cmp(&self, other: &Cow<'a, Path>) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl<'a, 'b> PartialOrd<PathBuf> for OsStr
1.8.0[src]
fn partial_cmp(&self, other: &PathBuf) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl<'a, 'b> PartialOrd<OsStr> for Path
1.8.0[src]
fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl<'a, 'b> PartialOrd<&'a OsStr> for OsString
1.8.0[src]
fn partial_cmp(&self, other: &&'a OsStr) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl<'a, 'b> PartialOrd<OsStr> for PathBuf
1.8.0[src]
fn partial_cmp(&self, other: &OsStr) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl<'a, 'b> PartialOrd<OsString> for &'a OsStr
1.8.0[src]
fn partial_cmp(&self, other: &OsString) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
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]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
[src]
impl Debug for OsStr
[src]
Auto Trait Implementations
impl Send for OsStr
impl Unpin for OsStr
impl Sync for OsStr
impl RefUnwindSafe for OsStr
impl UnwindSafe for OsStr
Blanket Implementations
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
ⓘImportant traits for &'_ mut Wfn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,