2019-02-10 20:23:21 +01:00
|
|
|
|
use crate::borrow::{Borrow, Cow};
|
|
|
|
|
use crate::cmp;
|
2019-12-22 23:42:04 +01:00
|
|
|
|
use crate::fmt;
|
2019-02-10 20:23:21 +01:00
|
|
|
|
use crate::hash::{Hash, Hasher};
|
2019-12-22 23:42:04 +01:00
|
|
|
|
use crate::ops;
|
2019-02-10 20:23:21 +01:00
|
|
|
|
use crate::rc::Rc;
|
|
|
|
|
use crate::sync::Arc;
|
2015-01-22 00:55:31 +01:00
|
|
|
|
|
2019-02-10 20:23:21 +01:00
|
|
|
|
use crate::sys::os_str::{Buf, Slice};
|
2019-12-22 23:42:04 +01:00
|
|
|
|
use crate::sys_common::{AsInner, FromInner, IntoInner};
|
2015-01-22 00:55:31 +01:00
|
|
|
|
|
2016-01-07 11:58:08 +01:00
|
|
|
|
/// A type that can represent owned, mutable platform-native strings, but is
|
2016-03-10 13:14:00 +01:00
|
|
|
|
/// cheaply inter-convertible with Rust strings.
|
2016-01-07 11:58:08 +01:00
|
|
|
|
///
|
|
|
|
|
/// The need for this type arises from the fact that:
|
|
|
|
|
///
|
|
|
|
|
/// * On Unix systems, strings are often arbitrary sequences of non-zero
|
|
|
|
|
/// bytes, in many cases interpreted as UTF-8.
|
|
|
|
|
///
|
|
|
|
|
/// * On Windows, strings are often arbitrary sequences of non-zero 16-bit
|
|
|
|
|
/// values, interpreted as UTF-16 when it is valid to do so.
|
|
|
|
|
///
|
2017-06-25 23:23:43 +02:00
|
|
|
|
/// * In Rust, strings are always valid UTF-8, which may contain zeros.
|
2016-01-07 11:58:08 +01:00
|
|
|
|
///
|
2017-01-21 16:38:54 +01:00
|
|
|
|
/// `OsString` and [`OsStr`] bridge this gap by simultaneously representing Rust
|
2016-01-07 11:58:08 +01:00
|
|
|
|
/// and platform-native string values, and in particular allowing a Rust string
|
2019-02-09 22:23:30 +01:00
|
|
|
|
/// to be converted into an "OS" string with no cost if possible. A consequence
|
2018-09-18 03:10:36 +02:00
|
|
|
|
/// of this is that `OsString` instances are *not* `NUL` terminated; in order
|
2018-11-27 03:59:49 +01:00
|
|
|
|
/// to pass to e.g., Unix system call, you should create a [`CStr`].
|
2017-09-25 20:51:28 +02:00
|
|
|
|
///
|
2018-01-11 22:01:32 +01:00
|
|
|
|
/// `OsString` is to [`&OsStr`] as [`String`] is to [`&str`]: the former
|
2017-09-25 20:51:28 +02:00
|
|
|
|
/// in each pair are owned strings; the latter are borrowed
|
|
|
|
|
/// references.
|
|
|
|
|
///
|
2019-07-07 15:38:53 +02:00
|
|
|
|
/// Note, `OsString` and [`OsStr`] internally do not necessarily hold strings in
|
2018-11-10 07:59:42 +01:00
|
|
|
|
/// the form native to the platform; While on Unix, strings are stored as a
|
|
|
|
|
/// sequence of 8-bit values, on Windows, where strings are 16-bit value based
|
|
|
|
|
/// as just discussed, strings are also actually stored as a sequence of 8-bit
|
|
|
|
|
/// values, encoded in a less-strict variant of UTF-8. This is useful to
|
|
|
|
|
/// understand when handling capacity and length values.
|
|
|
|
|
///
|
2017-09-25 20:51:28 +02:00
|
|
|
|
/// # Creating an `OsString`
|
|
|
|
|
///
|
|
|
|
|
/// **From a Rust string**: `OsString` implements
|
2017-10-20 21:29:35 +02:00
|
|
|
|
/// [`From`]`<`[`String`]`>`, so you can use `my_string.from` to
|
2017-09-25 20:51:28 +02:00
|
|
|
|
/// create an `OsString` from a normal Rust string.
|
|
|
|
|
///
|
|
|
|
|
/// **From slices:** Just like you can start with an empty Rust
|
|
|
|
|
/// [`String`] and then [`push_str`][String.push_str] `&str`
|
|
|
|
|
/// sub-string slices into it, you can create an empty `OsString` with
|
|
|
|
|
/// the [`new`] method and then push string slices into it with the
|
|
|
|
|
/// [`push`] method.
|
|
|
|
|
///
|
|
|
|
|
/// # Extracting a borrowed reference to the whole OS string
|
|
|
|
|
///
|
|
|
|
|
/// You can use the [`as_os_str`] method to get an `&`[`OsStr`] from
|
|
|
|
|
/// an `OsString`; this is effectively a borrowed reference to the
|
|
|
|
|
/// whole string.
|
|
|
|
|
///
|
|
|
|
|
/// # Conversions
|
|
|
|
|
///
|
2017-09-26 15:56:44 +02:00
|
|
|
|
/// See the [module's toplevel documentation about conversions][conversions] for a discussion on
|
2018-04-15 16:17:18 +02:00
|
|
|
|
/// the traits which `OsString` implements for [conversions] from/to native representations.
|
2017-01-21 16:38:54 +01:00
|
|
|
|
///
|
|
|
|
|
/// [`OsStr`]: struct.OsStr.html
|
2018-01-11 22:01:32 +01:00
|
|
|
|
/// [`&OsStr`]: struct.OsStr.html
|
2018-09-18 03:10:36 +02:00
|
|
|
|
/// [`CStr`]: struct.CStr.html
|
2017-09-25 20:51:28 +02:00
|
|
|
|
/// [`From`]: ../convert/trait.From.html
|
|
|
|
|
/// [`String`]: ../string/struct.String.html
|
|
|
|
|
/// [`&str`]: ../primitive.str.html
|
|
|
|
|
/// [`u8`]: ../primitive.u8.html
|
|
|
|
|
/// [`u16`]: ../primitive.u16.html
|
|
|
|
|
/// [String.push_str]: ../string/struct.String.html#method.push_str
|
2017-10-02 22:46:10 +02:00
|
|
|
|
/// [`new`]: #method.new
|
|
|
|
|
/// [`push`]: #method.push
|
|
|
|
|
/// [`as_os_str`]: #method.as_os_str
|
2018-04-15 16:17:18 +02:00
|
|
|
|
/// [conversions]: index.html#conversions
|
2015-01-22 00:55:31 +01:00
|
|
|
|
#[derive(Clone)]
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-22 00:55:31 +01:00
|
|
|
|
pub struct OsString {
|
2019-12-22 23:42:04 +01:00
|
|
|
|
inner: Buf,
|
2015-01-22 00:55:31 +01:00
|
|
|
|
}
|
|
|
|
|
|
2017-09-25 20:51:28 +02:00
|
|
|
|
/// Borrowed reference to an OS string (see [`OsString`]).
|
|
|
|
|
///
|
|
|
|
|
/// This type represents a borrowed reference to a string in the operating system's preferred
|
|
|
|
|
/// representation.
|
|
|
|
|
///
|
2018-01-11 22:01:32 +01:00
|
|
|
|
/// `&OsStr` is to [`OsString`] as [`&str`] is to [`String`]: the former in each pair are borrowed
|
2017-09-25 20:51:28 +02:00
|
|
|
|
/// references; the latter are owned strings.
|
|
|
|
|
///
|
2017-09-26 15:56:44 +02:00
|
|
|
|
/// See the [module's toplevel documentation about conversions][conversions] for a discussion on
|
2018-04-15 16:17:18 +02:00
|
|
|
|
/// the traits which `OsStr` implements for [conversions] from/to native representations.
|
2017-01-21 16:38:54 +01:00
|
|
|
|
///
|
|
|
|
|
/// [`OsString`]: struct.OsString.html
|
2018-01-11 17:20:30 +01:00
|
|
|
|
/// [`&str`]: ../primitive.str.html
|
|
|
|
|
/// [`String`]: ../string/struct.String.html
|
2017-09-25 20:51:28 +02:00
|
|
|
|
/// [conversions]: index.html#conversions
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2019-06-19 22:15:19 +02:00
|
|
|
|
// FIXME:
|
|
|
|
|
// `OsStr::from_inner` current implementation relies
|
|
|
|
|
// on `OsStr` being layout-compatible with `Slice`.
|
|
|
|
|
// When attribute privacy is implemented, `OsStr` should be annotated as `#[repr(transparent)]`.
|
|
|
|
|
// Anyway, `OsStr` representation and layout are considered implementation detail, are
|
|
|
|
|
// not documented and must not be relied upon.
|
2015-01-22 00:55:31 +01:00
|
|
|
|
pub struct OsStr {
|
2019-12-22 23:42:04 +01:00
|
|
|
|
inner: Slice,
|
2015-01-22 00:55:31 +01:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl OsString {
|
2015-01-27 21:20:58 +01:00
|
|
|
|
/// Constructs a new empty `OsString`.
|
2017-01-21 15:26:06 +01:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::ffi::OsString;
|
|
|
|
|
///
|
|
|
|
|
/// let os_string = OsString::new();
|
|
|
|
|
/// ```
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-27 21:20:58 +01:00
|
|
|
|
pub fn new() -> OsString {
|
|
|
|
|
OsString { inner: Buf::from_string(String::new()) }
|
|
|
|
|
}
|
|
|
|
|
|
2017-01-21 16:38:54 +01:00
|
|
|
|
/// Converts to an [`OsStr`] slice.
|
|
|
|
|
///
|
|
|
|
|
/// [`OsStr`]: struct.OsStr.html
|
2017-01-21 15:26:06 +01:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::ffi::{OsString, OsStr};
|
|
|
|
|
///
|
|
|
|
|
/// let os_string = OsString::from("foo");
|
|
|
|
|
/// let os_str = OsStr::new("foo");
|
|
|
|
|
/// assert_eq!(os_string.as_os_str(), os_str);
|
|
|
|
|
/// ```
|
2015-03-31 00:15:27 +02:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
|
pub fn as_os_str(&self) -> &OsStr {
|
|
|
|
|
self
|
|
|
|
|
}
|
|
|
|
|
|
2017-01-21 16:38:54 +01:00
|
|
|
|
/// Converts the `OsString` into a [`String`] if it contains valid Unicode data.
|
2015-01-22 00:55:31 +01:00
|
|
|
|
///
|
|
|
|
|
/// On failure, ownership of the original `OsString` is returned.
|
2017-01-21 15:26:06 +01:00
|
|
|
|
///
|
2017-01-21 16:38:54 +01:00
|
|
|
|
/// [`String`]: ../../std/string/struct.String.html
|
|
|
|
|
///
|
2017-01-21 15:26:06 +01:00
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::ffi::OsString;
|
|
|
|
|
///
|
|
|
|
|
/// let os_string = OsString::from("foo");
|
|
|
|
|
/// let string = os_string.into_string();
|
|
|
|
|
/// assert_eq!(string, Ok(String::from("foo")));
|
|
|
|
|
/// ```
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-22 00:55:31 +01:00
|
|
|
|
pub fn into_string(self) -> Result<String, OsString> {
|
2019-12-22 23:42:04 +01:00
|
|
|
|
self.inner.into_string().map_err(|buf| OsString { inner: buf })
|
2015-01-22 00:55:31 +01:00
|
|
|
|
}
|
|
|
|
|
|
2017-01-21 16:38:54 +01:00
|
|
|
|
/// Extends the string with the given [`&OsStr`] slice.
|
|
|
|
|
///
|
|
|
|
|
/// [`&OsStr`]: struct.OsStr.html
|
2017-01-21 15:26:06 +01:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::ffi::OsString;
|
|
|
|
|
///
|
|
|
|
|
/// let mut os_string = OsString::from("foo");
|
|
|
|
|
/// os_string.push("bar");
|
|
|
|
|
/// assert_eq!(&os_string, "foobar");
|
|
|
|
|
/// ```
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-03-18 17:14:54 +01:00
|
|
|
|
pub fn push<T: AsRef<OsStr>>(&mut self, s: T) {
|
|
|
|
|
self.inner.push_slice(&s.as_ref().inner)
|
|
|
|
|
}
|
2016-02-12 18:21:57 +01:00
|
|
|
|
|
2016-04-07 19:42:53 +02:00
|
|
|
|
/// Creates a new `OsString` with the given capacity.
|
|
|
|
|
///
|
2017-08-15 21:45:21 +02:00
|
|
|
|
/// The string will be able to hold exactly `capacity` length units of other
|
2016-04-07 19:42:53 +02:00
|
|
|
|
/// OS strings without reallocating. If `capacity` is 0, the string will not
|
|
|
|
|
/// allocate.
|
2016-02-12 18:21:57 +01:00
|
|
|
|
///
|
|
|
|
|
/// See main `OsString` documentation information about encoding.
|
2017-01-21 15:26:06 +01:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::ffi::OsString;
|
|
|
|
|
///
|
2019-08-22 19:27:16 +02:00
|
|
|
|
/// let mut os_string = OsString::with_capacity(10);
|
2017-01-21 15:26:06 +01:00
|
|
|
|
/// let capacity = os_string.capacity();
|
|
|
|
|
///
|
|
|
|
|
/// // This push is done without reallocating
|
|
|
|
|
/// os_string.push("foo");
|
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(capacity, os_string.capacity());
|
|
|
|
|
/// ```
|
2016-04-07 19:42:53 +02:00
|
|
|
|
#[stable(feature = "osstring_simple_functions", since = "1.9.0")]
|
2016-02-12 18:21:57 +01:00
|
|
|
|
pub fn with_capacity(capacity: usize) -> OsString {
|
2019-12-22 23:42:04 +01:00
|
|
|
|
OsString { inner: Buf::with_capacity(capacity) }
|
2016-02-12 18:21:57 +01:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Truncates the `OsString` to zero length.
|
2017-01-21 15:26:06 +01:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::ffi::OsString;
|
|
|
|
|
///
|
|
|
|
|
/// let mut os_string = OsString::from("foo");
|
|
|
|
|
/// assert_eq!(&os_string, "foo");
|
|
|
|
|
///
|
|
|
|
|
/// os_string.clear();
|
|
|
|
|
/// assert_eq!(&os_string, "");
|
|
|
|
|
/// ```
|
2016-04-07 19:42:53 +02:00
|
|
|
|
#[stable(feature = "osstring_simple_functions", since = "1.9.0")]
|
2016-02-12 18:21:57 +01:00
|
|
|
|
pub fn clear(&mut self) {
|
|
|
|
|
self.inner.clear()
|
|
|
|
|
}
|
|
|
|
|
|
2016-04-07 19:42:53 +02:00
|
|
|
|
/// Returns the capacity this `OsString` can hold without reallocating.
|
2016-02-12 18:21:57 +01:00
|
|
|
|
///
|
|
|
|
|
/// See `OsString` introduction for information about encoding.
|
2017-01-21 15:26:06 +01:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::ffi::OsString;
|
|
|
|
|
///
|
2019-08-22 19:27:16 +02:00
|
|
|
|
/// let os_string = OsString::with_capacity(10);
|
2017-01-21 15:26:06 +01:00
|
|
|
|
/// assert!(os_string.capacity() >= 10);
|
|
|
|
|
/// ```
|
2016-04-07 19:42:53 +02:00
|
|
|
|
#[stable(feature = "osstring_simple_functions", since = "1.9.0")]
|
2016-02-12 18:21:57 +01:00
|
|
|
|
pub fn capacity(&self) -> usize {
|
|
|
|
|
self.inner.capacity()
|
|
|
|
|
}
|
|
|
|
|
|
2016-04-07 19:42:53 +02:00
|
|
|
|
/// Reserves capacity for at least `additional` more capacity to be inserted
|
|
|
|
|
/// in the given `OsString`.
|
|
|
|
|
///
|
|
|
|
|
/// The collection may reserve more space to avoid frequent reallocations.
|
2017-03-12 21:21:34 +01:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::ffi::OsString;
|
|
|
|
|
///
|
|
|
|
|
/// let mut s = OsString::new();
|
|
|
|
|
/// s.reserve(10);
|
|
|
|
|
/// assert!(s.capacity() >= 10);
|
|
|
|
|
/// ```
|
2016-04-07 19:42:53 +02:00
|
|
|
|
#[stable(feature = "osstring_simple_functions", since = "1.9.0")]
|
2016-02-12 18:21:57 +01:00
|
|
|
|
pub fn reserve(&mut self, additional: usize) {
|
|
|
|
|
self.inner.reserve(additional)
|
|
|
|
|
}
|
|
|
|
|
|
2016-04-07 19:42:53 +02:00
|
|
|
|
/// Reserves the minimum capacity for exactly `additional` more capacity to
|
|
|
|
|
/// be inserted in the given `OsString`. Does nothing if the capacity is
|
2016-02-12 18:21:57 +01:00
|
|
|
|
/// already sufficient.
|
|
|
|
|
///
|
|
|
|
|
/// Note that the allocator may give the collection more space than it
|
2019-02-09 23:16:58 +01:00
|
|
|
|
/// requests. Therefore, capacity can not be relied upon to be precisely
|
2016-02-12 18:21:57 +01:00
|
|
|
|
/// minimal. Prefer reserve if future insertions are expected.
|
2017-03-12 21:21:58 +01:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::ffi::OsString;
|
|
|
|
|
///
|
|
|
|
|
/// let mut s = OsString::new();
|
|
|
|
|
/// s.reserve_exact(10);
|
|
|
|
|
/// assert!(s.capacity() >= 10);
|
|
|
|
|
/// ```
|
2016-04-07 19:42:53 +02:00
|
|
|
|
#[stable(feature = "osstring_simple_functions", since = "1.9.0")]
|
2016-02-12 18:21:57 +01:00
|
|
|
|
pub fn reserve_exact(&mut self, additional: usize) {
|
|
|
|
|
self.inner.reserve_exact(additional)
|
|
|
|
|
}
|
2017-02-01 04:46:16 +01:00
|
|
|
|
|
2017-03-10 06:23:54 +01:00
|
|
|
|
/// Shrinks the capacity of the `OsString` to match its length.
|
2017-03-12 21:22:12 +01:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::ffi::OsString;
|
|
|
|
|
///
|
|
|
|
|
/// let mut s = OsString::from("foo");
|
|
|
|
|
///
|
|
|
|
|
/// s.reserve(100);
|
|
|
|
|
/// assert!(s.capacity() >= 100);
|
|
|
|
|
///
|
|
|
|
|
/// s.shrink_to_fit();
|
|
|
|
|
/// assert_eq!(3, s.capacity());
|
|
|
|
|
/// ```
|
2017-06-08 17:35:46 +02:00
|
|
|
|
#[stable(feature = "osstring_shrink_to_fit", since = "1.19.0")]
|
2017-03-10 06:23:54 +01:00
|
|
|
|
pub fn shrink_to_fit(&mut self) {
|
|
|
|
|
self.inner.shrink_to_fit()
|
|
|
|
|
}
|
|
|
|
|
|
2018-03-27 00:24:31 +02:00
|
|
|
|
/// Shrinks the capacity of the `OsString` with a lower bound.
|
|
|
|
|
///
|
|
|
|
|
/// The capacity will remain at least as large as both the length
|
|
|
|
|
/// and the supplied value.
|
|
|
|
|
///
|
|
|
|
|
/// Panics if the current capacity is smaller than the supplied
|
|
|
|
|
/// minimum capacity.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(shrink_to)]
|
|
|
|
|
/// use std::ffi::OsString;
|
|
|
|
|
///
|
|
|
|
|
/// let mut s = OsString::from("foo");
|
|
|
|
|
///
|
|
|
|
|
/// s.reserve(100);
|
|
|
|
|
/// assert!(s.capacity() >= 100);
|
|
|
|
|
///
|
|
|
|
|
/// s.shrink_to(10);
|
|
|
|
|
/// assert!(s.capacity() >= 10);
|
|
|
|
|
/// s.shrink_to(0);
|
|
|
|
|
/// assert!(s.capacity() >= 3);
|
|
|
|
|
/// ```
|
|
|
|
|
#[inline]
|
2019-12-22 23:42:04 +01:00
|
|
|
|
#[unstable(feature = "shrink_to", reason = "new API", issue = "56431")]
|
2018-03-27 00:24:31 +02:00
|
|
|
|
pub fn shrink_to(&mut self, min_capacity: usize) {
|
|
|
|
|
self.inner.shrink_to(min_capacity)
|
|
|
|
|
}
|
|
|
|
|
|
2017-05-24 19:33:40 +02:00
|
|
|
|
/// Converts this `OsString` into a boxed [`OsStr`].
|
|
|
|
|
///
|
|
|
|
|
/// [`OsStr`]: struct.OsStr.html
|
2017-03-12 21:22:29 +01:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::ffi::{OsString, OsStr};
|
|
|
|
|
///
|
|
|
|
|
/// let s = OsString::from("hello");
|
|
|
|
|
///
|
|
|
|
|
/// let b: Box<OsStr> = s.into_boxed_os_str();
|
|
|
|
|
/// ```
|
2017-07-21 00:44:35 +02:00
|
|
|
|
#[stable(feature = "into_boxed_os_str", since = "1.20.0")]
|
2017-02-01 04:46:16 +01:00
|
|
|
|
pub fn into_boxed_os_str(self) -> Box<OsStr> {
|
2017-09-28 14:07:49 +02:00
|
|
|
|
let rw = Box::into_raw(self.inner.into_box()) as *mut OsStr;
|
|
|
|
|
unsafe { Box::from_raw(rw) }
|
2017-02-01 04:46:16 +01:00
|
|
|
|
}
|
2015-03-18 17:14:54 +01:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
|
impl From<String> for OsString {
|
2018-07-11 13:21:10 +02:00
|
|
|
|
/// Converts a [`String`] into a [`OsString`].
|
2018-07-23 15:38:15 +02:00
|
|
|
|
///
|
2018-07-11 13:21:10 +02:00
|
|
|
|
/// The conversion copies the data, and includes an allocation on the heap.
|
2019-05-04 16:48:57 +02:00
|
|
|
|
///
|
|
|
|
|
/// [`OsString`]: ../../std/ffi/struct.OsString.html
|
2015-03-18 17:14:54 +01:00
|
|
|
|
fn from(s: String) -> OsString {
|
|
|
|
|
OsString { inner: Buf::from_string(s) }
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2019-03-10 04:10:28 +01:00
|
|
|
|
impl<T: ?Sized + AsRef<OsStr>> From<&T> for OsString {
|
|
|
|
|
fn from(s: &T) -> OsString {
|
2015-03-26 21:39:23 +01:00
|
|
|
|
s.as_ref().to_os_string()
|
2015-03-02 19:46:05 +01:00
|
|
|
|
}
|
2015-01-22 00:55:31 +01:00
|
|
|
|
}
|
|
|
|
|
|
2015-03-22 00:33:27 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
|
impl ops::Index<ops::RangeFull> for OsString {
|
|
|
|
|
type Output = OsStr;
|
|
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
|
fn index(&self, _index: ops::RangeFull) -> &OsStr {
|
2015-07-24 03:04:55 +02:00
|
|
|
|
OsStr::from_inner(self.inner.as_slice())
|
2015-03-22 00:33:27 +01:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2020-03-16 18:13:07 +01:00
|
|
|
|
#[stable(feature = "mut_osstr", since = "1.44.0")]
|
|
|
|
|
impl ops::IndexMut<ops::RangeFull> for OsString {
|
|
|
|
|
#[inline]
|
|
|
|
|
fn index_mut(&mut self, _index: ops::RangeFull) -> &mut OsStr {
|
|
|
|
|
OsStr::from_inner_mut(self.inner.as_mut_slice())
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-22 00:55:31 +01:00
|
|
|
|
impl ops::Deref for OsString {
|
|
|
|
|
type Target = OsStr;
|
|
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
|
fn deref(&self) -> &OsStr {
|
2015-02-18 20:48:57 +01:00
|
|
|
|
&self[..]
|
2015-01-22 00:55:31 +01:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2020-03-16 18:13:07 +01:00
|
|
|
|
#[stable(feature = "mut_osstr", since = "1.44.0")]
|
|
|
|
|
impl ops::DerefMut for OsString {
|
|
|
|
|
#[inline]
|
|
|
|
|
fn deref_mut(&mut self) -> &mut OsStr {
|
|
|
|
|
&mut self[..]
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-03-22 00:38:44 +01:00
|
|
|
|
#[stable(feature = "osstring_default", since = "1.9.0")]
|
2016-03-21 17:45:08 +01:00
|
|
|
|
impl Default for OsString {
|
2016-09-11 13:30:09 +02:00
|
|
|
|
/// Constructs an empty `OsString`.
|
2016-03-21 17:45:08 +01:00
|
|
|
|
#[inline]
|
|
|
|
|
fn default() -> OsString {
|
|
|
|
|
OsString::new()
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2017-06-12 21:21:53 +02:00
|
|
|
|
impl fmt::Debug for OsString {
|
2019-03-01 09:34:11 +01:00
|
|
|
|
fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
|
2015-01-22 00:55:31 +01:00
|
|
|
|
fmt::Debug::fmt(&**self, formatter)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-27 21:20:58 +01:00
|
|
|
|
impl PartialEq for OsString {
|
|
|
|
|
fn eq(&self, other: &OsString) -> bool {
|
|
|
|
|
&**self == &**other
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-27 21:20:58 +01:00
|
|
|
|
impl PartialEq<str> for OsString {
|
|
|
|
|
fn eq(&self, other: &str) -> bool {
|
|
|
|
|
&**self == other
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-27 21:20:58 +01:00
|
|
|
|
impl PartialEq<OsString> for str {
|
|
|
|
|
fn eq(&self, other: &OsString) -> bool {
|
|
|
|
|
&**other == self
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2018-09-13 23:25:43 +02:00
|
|
|
|
#[stable(feature = "os_str_str_ref_eq", since = "1.29.0")]
|
2019-03-10 04:10:28 +01:00
|
|
|
|
impl PartialEq<&str> for OsString {
|
|
|
|
|
fn eq(&self, other: &&str) -> bool {
|
2018-05-29 18:16:49 +02:00
|
|
|
|
**self == **other
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2018-09-13 23:25:43 +02:00
|
|
|
|
#[stable(feature = "os_str_str_ref_eq", since = "1.29.0")]
|
2018-05-29 18:16:49 +02:00
|
|
|
|
impl<'a> PartialEq<OsString> for &'a str {
|
|
|
|
|
fn eq(&self, other: &OsString) -> bool {
|
|
|
|
|
**other == **self
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-27 21:20:58 +01:00
|
|
|
|
impl Eq for OsString {}
|
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-27 21:20:58 +01:00
|
|
|
|
impl PartialOrd for OsString {
|
|
|
|
|
#[inline]
|
|
|
|
|
fn partial_cmp(&self, other: &OsString) -> Option<cmp::Ordering> {
|
|
|
|
|
(&**self).partial_cmp(&**other)
|
|
|
|
|
}
|
|
|
|
|
#[inline]
|
2019-12-22 23:42:04 +01:00
|
|
|
|
fn lt(&self, other: &OsString) -> bool {
|
|
|
|
|
&**self < &**other
|
|
|
|
|
}
|
2015-01-27 21:20:58 +01:00
|
|
|
|
#[inline]
|
2019-12-22 23:42:04 +01:00
|
|
|
|
fn le(&self, other: &OsString) -> bool {
|
|
|
|
|
&**self <= &**other
|
|
|
|
|
}
|
2015-01-27 21:20:58 +01:00
|
|
|
|
#[inline]
|
2019-12-22 23:42:04 +01:00
|
|
|
|
fn gt(&self, other: &OsString) -> bool {
|
|
|
|
|
&**self > &**other
|
|
|
|
|
}
|
2015-01-27 21:20:58 +01:00
|
|
|
|
#[inline]
|
2019-12-22 23:42:04 +01:00
|
|
|
|
fn ge(&self, other: &OsString) -> bool {
|
|
|
|
|
&**self >= &**other
|
|
|
|
|
}
|
2015-01-27 21:20:58 +01:00
|
|
|
|
}
|
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-27 21:20:58 +01:00
|
|
|
|
impl PartialOrd<str> for OsString {
|
|
|
|
|
#[inline]
|
|
|
|
|
fn partial_cmp(&self, other: &str) -> Option<cmp::Ordering> {
|
|
|
|
|
(&**self).partial_cmp(other)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-27 21:20:58 +01:00
|
|
|
|
impl Ord for OsString {
|
|
|
|
|
#[inline]
|
|
|
|
|
fn cmp(&self, other: &OsString) -> cmp::Ordering {
|
|
|
|
|
(&**self).cmp(&**other)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-02-18 05:48:07 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
|
impl Hash for OsString {
|
|
|
|
|
#[inline]
|
|
|
|
|
fn hash<H: Hasher>(&self, state: &mut H) {
|
|
|
|
|
(&**self).hash(state)
|
|
|
|
|
}
|
|
|
|
|
}
|
2015-01-27 21:20:58 +01:00
|
|
|
|
|
2015-01-22 00:55:31 +01:00
|
|
|
|
impl OsStr {
|
2015-04-13 16:21:32 +02:00
|
|
|
|
/// Coerces into an `OsStr` slice.
|
2016-08-18 04:56:43 +02:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::ffi::OsStr;
|
|
|
|
|
///
|
|
|
|
|
/// let os_str = OsStr::new("foo");
|
|
|
|
|
/// ```
|
2019-12-09 11:39:57 +01:00
|
|
|
|
#[inline]
|
2015-03-31 00:15:27 +02:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
|
pub fn new<S: AsRef<OsStr> + ?Sized>(s: &S) -> &OsStr {
|
|
|
|
|
s.as_ref()
|
|
|
|
|
}
|
|
|
|
|
|
2019-12-09 11:39:57 +01:00
|
|
|
|
#[inline]
|
2015-07-24 03:04:55 +02:00
|
|
|
|
fn from_inner(inner: &Slice) -> &OsStr {
|
2020-03-16 21:12:54 +01:00
|
|
|
|
// Safety: OsStr is just a wrapper of Slice,
|
|
|
|
|
// therefore converting &Slice to &OsStr is safe.
|
2017-09-28 14:07:49 +02:00
|
|
|
|
unsafe { &*(inner as *const Slice as *const OsStr) }
|
2015-07-24 03:04:55 +02:00
|
|
|
|
}
|
|
|
|
|
|
2020-03-16 18:13:07 +01:00
|
|
|
|
#[inline]
|
|
|
|
|
fn from_inner_mut(inner: &mut Slice) -> &mut OsStr {
|
2020-03-16 21:12:54 +01:00
|
|
|
|
// Safety: OsStr is just a wrapper of Slice,
|
|
|
|
|
// therefore converting &mut Slice to &mut OsStr is safe.
|
2020-03-20 14:00:53 +01:00
|
|
|
|
// Any method that mutates OsStr must be careful not to
|
|
|
|
|
// break platform-specific encoding, in particular Wtf8 on Windows.
|
2020-03-16 18:13:07 +01:00
|
|
|
|
unsafe { &mut *(inner as *mut Slice as *mut OsStr) }
|
|
|
|
|
}
|
|
|
|
|
|
2017-01-21 16:38:54 +01:00
|
|
|
|
/// Yields a [`&str`] slice if the `OsStr` is valid Unicode.
|
2015-01-22 00:55:31 +01:00
|
|
|
|
///
|
|
|
|
|
/// This conversion may entail doing a check for UTF-8 validity.
|
2017-01-05 04:47:23 +01:00
|
|
|
|
///
|
2017-01-21 16:38:54 +01:00
|
|
|
|
/// [`&str`]: ../../std/primitive.str.html
|
|
|
|
|
///
|
2017-01-05 04:47:23 +01:00
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::ffi::OsStr;
|
|
|
|
|
///
|
|
|
|
|
/// let os_str = OsStr::new("foo");
|
|
|
|
|
/// assert_eq!(os_str.to_str(), Some("foo"));
|
|
|
|
|
/// ```
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-22 00:55:31 +01:00
|
|
|
|
pub fn to_str(&self) -> Option<&str> {
|
|
|
|
|
self.inner.to_str()
|
|
|
|
|
}
|
|
|
|
|
|
2017-01-21 16:38:54 +01:00
|
|
|
|
/// Converts an `OsStr` to a [`Cow`]`<`[`str`]`>`.
|
2015-01-22 00:55:31 +01:00
|
|
|
|
///
|
2018-08-11 20:09:59 +02:00
|
|
|
|
/// Any non-Unicode sequences are replaced with
|
|
|
|
|
/// [`U+FFFD REPLACEMENT CHARACTER`][U+FFFD].
|
2017-01-05 04:47:23 +01:00
|
|
|
|
///
|
2017-01-21 16:38:54 +01:00
|
|
|
|
/// [`Cow`]: ../../std/borrow/enum.Cow.html
|
|
|
|
|
/// [`str`]: ../../std/primitive.str.html
|
2018-08-11 20:09:59 +02:00
|
|
|
|
/// [U+FFFD]: ../../std/char/constant.REPLACEMENT_CHARACTER.html
|
2017-01-21 16:38:54 +01:00
|
|
|
|
///
|
2017-01-05 04:47:23 +01:00
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
2018-11-10 07:17:36 +01:00
|
|
|
|
/// 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<66>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<66>o");
|
|
|
|
|
/// }
|
2017-01-05 04:47:23 +01:00
|
|
|
|
/// ```
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2019-03-01 09:34:11 +01:00
|
|
|
|
pub fn to_string_lossy(&self) -> Cow<'_, str> {
|
2015-01-22 00:55:31 +01:00
|
|
|
|
self.inner.to_string_lossy()
|
|
|
|
|
}
|
|
|
|
|
|
2017-01-21 16:38:54 +01:00
|
|
|
|
/// Copies the slice into an owned [`OsString`].
|
|
|
|
|
///
|
|
|
|
|
/// [`OsString`]: struct.OsString.html
|
2017-03-12 20:04:32 +01:00
|
|
|
|
///
|
|
|
|
|
/// # 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"));
|
|
|
|
|
/// ```
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-22 00:55:31 +01:00
|
|
|
|
pub fn to_os_string(&self) -> OsString {
|
|
|
|
|
OsString { inner: self.inner.to_owned() }
|
|
|
|
|
}
|
|
|
|
|
|
2016-02-12 18:21:57 +01:00
|
|
|
|
/// Checks whether the `OsStr` is empty.
|
2016-08-18 04:56:43 +02:00
|
|
|
|
///
|
|
|
|
|
/// # 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());
|
|
|
|
|
/// ```
|
2016-04-07 19:42:53 +02:00
|
|
|
|
#[stable(feature = "osstring_simple_functions", since = "1.9.0")]
|
2020-01-10 19:20:40 +01:00
|
|
|
|
#[inline]
|
2016-02-12 18:21:57 +01:00
|
|
|
|
pub fn is_empty(&self) -> bool {
|
|
|
|
|
self.inner.inner.is_empty()
|
|
|
|
|
}
|
|
|
|
|
|
2016-04-07 19:42:53 +02:00
|
|
|
|
/// Returns the length of this `OsStr`.
|
|
|
|
|
///
|
2018-11-10 08:35:15 +01:00
|
|
|
|
/// Note that this does **not** return the number of bytes in the string in
|
|
|
|
|
/// OS string form.
|
2016-02-12 18:21:57 +01:00
|
|
|
|
///
|
2019-08-22 13:14:42 +02:00
|
|
|
|
/// The length returned is that of the underlying storage used by `OsStr`.
|
2018-11-10 08:35:15 +01:00
|
|
|
|
/// 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.
|
2016-08-18 04:56:43 +02:00
|
|
|
|
///
|
2018-11-10 08:35:15 +01:00
|
|
|
|
/// This number is simply useful for passing to other methods, like
|
|
|
|
|
/// [`OsString::with_capacity`] to avoid reallocations.
|
|
|
|
|
///
|
|
|
|
|
/// [`OsString`]: struct.OsString.html
|
2017-01-21 16:38:54 +01:00
|
|
|
|
/// [`OsString::with_capacity`]: struct.OsString.html#method.with_capacity
|
|
|
|
|
///
|
2016-08-18 04:56:43 +02:00
|
|
|
|
/// # 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);
|
|
|
|
|
/// ```
|
2016-04-07 19:42:53 +02:00
|
|
|
|
#[stable(feature = "osstring_simple_functions", since = "1.9.0")]
|
2016-02-12 18:21:57 +01:00
|
|
|
|
pub fn len(&self) -> usize {
|
|
|
|
|
self.inner.inner.len()
|
|
|
|
|
}
|
|
|
|
|
|
2017-05-24 19:33:40 +02:00
|
|
|
|
/// Converts a [`Box`]`<OsStr>` into an [`OsString`] without copying or allocating.
|
|
|
|
|
///
|
|
|
|
|
/// [`Box`]: ../boxed/struct.Box.html
|
|
|
|
|
/// [`OsString`]: struct.OsString.html
|
2017-07-21 00:44:35 +02:00
|
|
|
|
#[stable(feature = "into_boxed_os_str", since = "1.20.0")]
|
2017-02-14 02:37:42 +01:00
|
|
|
|
pub fn into_os_string(self: Box<OsStr>) -> OsString {
|
2017-09-28 14:07:49 +02:00
|
|
|
|
let boxed = unsafe { Box::from_raw(Box::into_raw(self) as *mut Slice) };
|
|
|
|
|
OsString { inner: Buf::from_box(boxed) }
|
2017-02-14 02:37:42 +01:00
|
|
|
|
}
|
|
|
|
|
|
2015-04-13 16:21:32 +02:00
|
|
|
|
/// Gets the underlying byte representation.
|
2015-01-22 00:55:31 +01:00
|
|
|
|
///
|
|
|
|
|
/// Note: it is *crucial* that this API is private, to avoid
|
|
|
|
|
/// revealing the internal, platform-specific encodings.
|
2019-12-09 11:39:57 +01:00
|
|
|
|
#[inline]
|
2015-01-22 00:55:31 +01:00
|
|
|
|
fn bytes(&self) -> &[u8] {
|
2017-09-30 16:01:41 +02:00
|
|
|
|
unsafe { &*(&self.inner as *const _ as *const [u8]) }
|
2015-01-22 00:55:31 +01:00
|
|
|
|
}
|
2020-03-11 20:53:55 +01:00
|
|
|
|
|
|
|
|
|
/// 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
|
|
|
|
|
/// [`to_ascii_lowercase`].
|
|
|
|
|
///
|
|
|
|
|
/// [`to_ascii_lowercase`]: #method.to_ascii_lowercase
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![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);
|
|
|
|
|
/// ```
|
2020-03-29 00:23:49 +01:00
|
|
|
|
#[unstable(feature = "osstring_ascii", issue = "70516")]
|
2020-03-11 20:53:55 +01:00
|
|
|
|
pub fn make_ascii_lowercase(&mut self) {
|
|
|
|
|
self.inner.make_ascii_lowercase()
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// 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
|
|
|
|
|
/// [`to_ascii_uppercase`].
|
|
|
|
|
///
|
|
|
|
|
/// [`to_ascii_uppercase`]: #method.to_ascii_uppercase
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![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);
|
|
|
|
|
/// ```
|
2020-03-29 00:23:49 +01:00
|
|
|
|
#[unstable(feature = "osstring_ascii", issue = "70516")]
|
2020-03-11 20:53:55 +01:00
|
|
|
|
pub fn make_ascii_uppercase(&mut self) {
|
|
|
|
|
self.inner.make_ascii_uppercase()
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// 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 [`make_ascii_lowercase`].
|
|
|
|
|
///
|
2020-03-12 17:40:57 +01:00
|
|
|
|
/// [`make_ascii_lowercase`]: #method.make_ascii_lowercase
|
|
|
|
|
///
|
2020-03-11 20:53:55 +01:00
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![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());
|
|
|
|
|
/// ```
|
2020-03-29 00:23:49 +01:00
|
|
|
|
#[unstable(feature = "osstring_ascii", issue = "70516")]
|
2020-03-11 20:53:55 +01:00
|
|
|
|
pub fn to_ascii_lowercase(&self) -> OsString {
|
|
|
|
|
OsString::from_inner(self.inner.to_ascii_lowercase())
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// 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 [`make_ascii_uppercase`].
|
|
|
|
|
///
|
2020-03-12 17:40:57 +01:00
|
|
|
|
/// [`make_ascii_uppercase`]: #method.make_ascii_uppercase
|
|
|
|
|
///
|
2020-03-11 20:53:55 +01:00
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![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());
|
|
|
|
|
/// ```
|
2020-03-29 00:23:49 +01:00
|
|
|
|
#[unstable(feature = "osstring_ascii", issue = "70516")]
|
2020-03-11 20:53:55 +01:00
|
|
|
|
pub fn to_ascii_uppercase(&self) -> OsString {
|
|
|
|
|
OsString::from_inner(self.inner.to_ascii_uppercase())
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Checks if all characters in this string are within the ASCII range.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![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());
|
|
|
|
|
/// ```
|
2020-03-29 00:23:49 +01:00
|
|
|
|
#[unstable(feature = "osstring_ascii", issue = "70516")]
|
2020-03-11 20:53:55 +01:00
|
|
|
|
pub fn is_ascii(&self) -> bool {
|
|
|
|
|
self.inner.is_ascii()
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// 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
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![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"));
|
|
|
|
|
/// ```
|
2020-03-29 00:23:49 +01:00
|
|
|
|
#[unstable(feature = "osstring_ascii", issue = "70516")]
|
2020-03-11 20:53:55 +01:00
|
|
|
|
pub fn eq_ignore_ascii_case<S: ?Sized + AsRef<OsStr>>(&self, other: &S) -> bool {
|
|
|
|
|
self.inner.eq_ignore_ascii_case(&other.as_ref().inner)
|
|
|
|
|
}
|
2015-01-22 00:55:31 +01:00
|
|
|
|
}
|
|
|
|
|
|
2017-02-01 04:46:16 +01:00
|
|
|
|
#[stable(feature = "box_from_os_str", since = "1.17.0")]
|
2019-03-10 04:10:28 +01:00
|
|
|
|
impl From<&OsStr> for Box<OsStr> {
|
|
|
|
|
fn from(s: &OsStr) -> Box<OsStr> {
|
2017-09-28 14:07:49 +02:00
|
|
|
|
let rw = Box::into_raw(s.inner.into_box()) as *mut OsStr;
|
|
|
|
|
unsafe { Box::from_raw(rw) }
|
2017-02-01 04:46:16 +01:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-05-20 09:38:39 +02:00
|
|
|
|
#[stable(feature = "os_string_from_box", since = "1.18.0")]
|
2017-05-20 21:32:11 +02:00
|
|
|
|
impl From<Box<OsStr>> for OsString {
|
2019-07-07 15:38:53 +02:00
|
|
|
|
/// Converts a [`Box`]`<`[`OsStr`]`>` into a `OsString` without copying or
|
|
|
|
|
/// allocating.
|
2018-07-11 13:21:10 +02:00
|
|
|
|
///
|
|
|
|
|
/// [`Box`]: ../boxed/struct.Box.html
|
2019-07-07 15:38:53 +02:00
|
|
|
|
/// [`OsStr`]: ../ffi/struct.OsStr.html
|
2017-02-14 02:37:42 +01:00
|
|
|
|
fn from(boxed: Box<OsStr>) -> OsString {
|
|
|
|
|
boxed.into_os_string()
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-06-13 01:08:37 +02:00
|
|
|
|
#[stable(feature = "box_from_os_string", since = "1.20.0")]
|
2017-05-20 21:40:53 +02:00
|
|
|
|
impl From<OsString> for Box<OsStr> {
|
2018-07-11 13:21:10 +02:00
|
|
|
|
/// Converts a [`OsString`] into a [`Box`]`<OsStr>` without copying or allocating.
|
|
|
|
|
///
|
|
|
|
|
/// [`Box`]: ../boxed/struct.Box.html
|
|
|
|
|
/// [`OsString`]: ../ffi/struct.OsString.html
|
2017-05-20 21:40:53 +02:00
|
|
|
|
fn from(s: OsString) -> Box<OsStr> {
|
|
|
|
|
s.into_boxed_os_str()
|
2017-02-14 02:37:42 +01:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2018-06-29 20:49:32 +02:00
|
|
|
|
#[stable(feature = "more_box_slice_clone", since = "1.29.0")]
|
|
|
|
|
impl Clone for Box<OsStr> {
|
|
|
|
|
#[inline]
|
|
|
|
|
fn clone(&self) -> Self {
|
|
|
|
|
self.to_os_string().into_boxed_os_str()
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-12-27 15:11:05 +01:00
|
|
|
|
#[stable(feature = "shared_from_slice2", since = "1.24.0")]
|
2017-11-14 20:31:07 +01:00
|
|
|
|
impl From<OsString> for Arc<OsStr> {
|
2018-07-11 13:21:10 +02:00
|
|
|
|
/// Converts a [`OsString`] into a [`Arc`]`<OsStr>` without copying or allocating.
|
|
|
|
|
///
|
|
|
|
|
/// [`Arc`]: ../sync/struct.Arc.html
|
|
|
|
|
/// [`OsString`]: ../ffi/struct.OsString.html
|
2017-11-14 20:31:07 +01:00
|
|
|
|
#[inline]
|
|
|
|
|
fn from(s: OsString) -> Arc<OsStr> {
|
|
|
|
|
let arc = s.inner.into_arc();
|
|
|
|
|
unsafe { Arc::from_raw(Arc::into_raw(arc) as *const OsStr) }
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-12-27 15:11:05 +01:00
|
|
|
|
#[stable(feature = "shared_from_slice2", since = "1.24.0")]
|
2019-03-10 04:10:28 +01:00
|
|
|
|
impl From<&OsStr> for Arc<OsStr> {
|
2017-11-14 20:31:07 +01:00
|
|
|
|
#[inline]
|
|
|
|
|
fn from(s: &OsStr) -> Arc<OsStr> {
|
|
|
|
|
let arc = s.inner.into_arc();
|
|
|
|
|
unsafe { Arc::from_raw(Arc::into_raw(arc) as *const OsStr) }
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-12-27 15:11:05 +01:00
|
|
|
|
#[stable(feature = "shared_from_slice2", since = "1.24.0")]
|
2017-11-14 20:31:07 +01:00
|
|
|
|
impl From<OsString> for Rc<OsStr> {
|
2018-07-11 13:21:10 +02:00
|
|
|
|
/// Converts a [`OsString`] into a [`Rc`]`<OsStr>` without copying or allocating.
|
|
|
|
|
///
|
|
|
|
|
/// [`Rc`]: ../rc/struct.Rc.html
|
|
|
|
|
/// [`OsString`]: ../ffi/struct.OsString.html
|
2017-11-14 20:31:07 +01:00
|
|
|
|
#[inline]
|
|
|
|
|
fn from(s: OsString) -> Rc<OsStr> {
|
|
|
|
|
let rc = s.inner.into_rc();
|
|
|
|
|
unsafe { Rc::from_raw(Rc::into_raw(rc) as *const OsStr) }
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-12-27 15:11:05 +01:00
|
|
|
|
#[stable(feature = "shared_from_slice2", since = "1.24.0")]
|
2019-03-10 04:10:28 +01:00
|
|
|
|
impl From<&OsStr> for Rc<OsStr> {
|
2017-11-14 20:31:07 +01:00
|
|
|
|
#[inline]
|
|
|
|
|
fn from(s: &OsStr) -> Rc<OsStr> {
|
|
|
|
|
let rc = s.inner.into_rc();
|
|
|
|
|
unsafe { Rc::from_raw(Rc::into_raw(rc) as *const OsStr) }
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2018-05-09 08:23:02 +02:00
|
|
|
|
#[stable(feature = "cow_from_osstr", since = "1.28.0")]
|
2018-04-22 23:57:52 +02:00
|
|
|
|
impl<'a> From<OsString> for Cow<'a, OsStr> {
|
|
|
|
|
#[inline]
|
|
|
|
|
fn from(s: OsString) -> Cow<'a, OsStr> {
|
|
|
|
|
Cow::Owned(s)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2018-05-09 08:23:02 +02:00
|
|
|
|
#[stable(feature = "cow_from_osstr", since = "1.28.0")]
|
2018-04-22 23:57:52 +02:00
|
|
|
|
impl<'a> From<&'a OsStr> for Cow<'a, OsStr> {
|
|
|
|
|
#[inline]
|
|
|
|
|
fn from(s: &'a OsStr) -> Cow<'a, OsStr> {
|
|
|
|
|
Cow::Borrowed(s)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2018-05-09 08:23:02 +02:00
|
|
|
|
#[stable(feature = "cow_from_osstr", since = "1.28.0")]
|
2018-04-22 23:57:52 +02:00
|
|
|
|
impl<'a> From<&'a OsString> for Cow<'a, OsStr> {
|
|
|
|
|
#[inline]
|
|
|
|
|
fn from(s: &'a OsString) -> Cow<'a, OsStr> {
|
|
|
|
|
Cow::Borrowed(s.as_os_str())
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2018-05-09 08:23:02 +02:00
|
|
|
|
#[stable(feature = "osstring_from_cow_osstr", since = "1.28.0")]
|
2018-04-27 21:27:38 +02:00
|
|
|
|
impl<'a> From<Cow<'a, OsStr>> for OsString {
|
|
|
|
|
#[inline]
|
|
|
|
|
fn from(s: Cow<'a, OsStr>) -> Self {
|
|
|
|
|
s.into_owned()
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-02-01 04:46:16 +01:00
|
|
|
|
#[stable(feature = "box_default_extra", since = "1.17.0")]
|
|
|
|
|
impl Default for Box<OsStr> {
|
|
|
|
|
fn default() -> Box<OsStr> {
|
2017-09-28 14:07:49 +02:00
|
|
|
|
let rw = Box::into_raw(Slice::empty_box()) as *mut OsStr;
|
|
|
|
|
unsafe { Box::from_raw(rw) }
|
2017-02-01 04:46:16 +01:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-03-22 00:38:44 +01:00
|
|
|
|
#[stable(feature = "osstring_default", since = "1.9.0")]
|
2019-02-18 04:42:36 +01:00
|
|
|
|
impl Default for &OsStr {
|
2016-09-11 13:30:09 +02:00
|
|
|
|
/// Creates an empty `OsStr`.
|
2016-03-21 17:45:36 +01:00
|
|
|
|
#[inline]
|
2019-02-18 04:42:36 +01:00
|
|
|
|
fn default() -> Self {
|
2016-03-22 00:38:44 +01:00
|
|
|
|
OsStr::new("")
|
2016-03-21 17:45:36 +01:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-22 00:55:31 +01:00
|
|
|
|
impl PartialEq for OsStr {
|
2019-12-09 11:39:57 +01:00
|
|
|
|
#[inline]
|
2015-01-22 00:55:31 +01:00
|
|
|
|
fn eq(&self, other: &OsStr) -> bool {
|
|
|
|
|
self.bytes().eq(other.bytes())
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-22 00:55:31 +01:00
|
|
|
|
impl PartialEq<str> for OsStr {
|
2019-12-09 11:39:57 +01:00
|
|
|
|
#[inline]
|
2015-01-22 00:55:31 +01:00
|
|
|
|
fn eq(&self, other: &str) -> bool {
|
2015-03-31 00:15:27 +02:00
|
|
|
|
*self == *OsStr::new(other)
|
2015-01-22 00:55:31 +01:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-22 00:55:31 +01:00
|
|
|
|
impl PartialEq<OsStr> for str {
|
2019-12-09 11:39:57 +01:00
|
|
|
|
#[inline]
|
2015-01-22 00:55:31 +01:00
|
|
|
|
fn eq(&self, other: &OsStr) -> bool {
|
2015-03-31 00:15:27 +02:00
|
|
|
|
*other == *OsStr::new(self)
|
2015-01-22 00:55:31 +01:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-22 00:55:31 +01:00
|
|
|
|
impl Eq for OsStr {}
|
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-22 00:55:31 +01:00
|
|
|
|
impl PartialOrd for OsStr {
|
|
|
|
|
#[inline]
|
|
|
|
|
fn partial_cmp(&self, other: &OsStr) -> Option<cmp::Ordering> {
|
|
|
|
|
self.bytes().partial_cmp(other.bytes())
|
|
|
|
|
}
|
|
|
|
|
#[inline]
|
2019-12-22 23:42:04 +01:00
|
|
|
|
fn lt(&self, other: &OsStr) -> bool {
|
|
|
|
|
self.bytes().lt(other.bytes())
|
|
|
|
|
}
|
2015-01-22 00:55:31 +01:00
|
|
|
|
#[inline]
|
2019-12-22 23:42:04 +01:00
|
|
|
|
fn le(&self, other: &OsStr) -> bool {
|
|
|
|
|
self.bytes().le(other.bytes())
|
|
|
|
|
}
|
2015-01-22 00:55:31 +01:00
|
|
|
|
#[inline]
|
2019-12-22 23:42:04 +01:00
|
|
|
|
fn gt(&self, other: &OsStr) -> bool {
|
|
|
|
|
self.bytes().gt(other.bytes())
|
|
|
|
|
}
|
2015-01-22 00:55:31 +01:00
|
|
|
|
#[inline]
|
2019-12-22 23:42:04 +01:00
|
|
|
|
fn ge(&self, other: &OsStr) -> bool {
|
|
|
|
|
self.bytes().ge(other.bytes())
|
|
|
|
|
}
|
2015-01-22 00:55:31 +01:00
|
|
|
|
}
|
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-22 00:55:31 +01:00
|
|
|
|
impl PartialOrd<str> for OsStr {
|
|
|
|
|
#[inline]
|
|
|
|
|
fn partial_cmp(&self, other: &str) -> Option<cmp::Ordering> {
|
2015-03-31 00:15:27 +02:00
|
|
|
|
self.partial_cmp(OsStr::new(other))
|
2015-01-22 00:55:31 +01:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// FIXME (#19470): cannot provide PartialOrd<OsStr> for str until we
|
|
|
|
|
// have more flexible coherence rules.
|
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-01-22 00:55:31 +01:00
|
|
|
|
impl Ord for OsStr {
|
|
|
|
|
#[inline]
|
2019-12-22 23:42:04 +01:00
|
|
|
|
fn cmp(&self, other: &OsStr) -> cmp::Ordering {
|
|
|
|
|
self.bytes().cmp(other.bytes())
|
|
|
|
|
}
|
2015-01-22 00:55:31 +01:00
|
|
|
|
}
|
|
|
|
|
|
2016-02-18 15:03:42 +01:00
|
|
|
|
macro_rules! impl_cmp {
|
|
|
|
|
($lhs:ty, $rhs: ty) => {
|
|
|
|
|
#[stable(feature = "cmp_os_str", since = "1.8.0")]
|
|
|
|
|
impl<'a, 'b> PartialEq<$rhs> for $lhs {
|
|
|
|
|
#[inline]
|
2019-12-22 23:42:04 +01:00
|
|
|
|
fn eq(&self, other: &$rhs) -> bool {
|
|
|
|
|
<OsStr as PartialEq>::eq(self, other)
|
|
|
|
|
}
|
2016-02-18 15:03:42 +01:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[stable(feature = "cmp_os_str", since = "1.8.0")]
|
|
|
|
|
impl<'a, 'b> PartialEq<$lhs> for $rhs {
|
|
|
|
|
#[inline]
|
2019-12-22 23:42:04 +01:00
|
|
|
|
fn eq(&self, other: &$lhs) -> bool {
|
|
|
|
|
<OsStr as PartialEq>::eq(self, other)
|
|
|
|
|
}
|
2016-02-18 15:03:42 +01:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[stable(feature = "cmp_os_str", since = "1.8.0")]
|
|
|
|
|
impl<'a, 'b> PartialOrd<$rhs> for $lhs {
|
|
|
|
|
#[inline]
|
|
|
|
|
fn partial_cmp(&self, other: &$rhs) -> Option<cmp::Ordering> {
|
|
|
|
|
<OsStr as PartialOrd>::partial_cmp(self, other)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[stable(feature = "cmp_os_str", since = "1.8.0")]
|
|
|
|
|
impl<'a, 'b> PartialOrd<$lhs> for $rhs {
|
|
|
|
|
#[inline]
|
|
|
|
|
fn partial_cmp(&self, other: &$lhs) -> Option<cmp::Ordering> {
|
|
|
|
|
<OsStr as PartialOrd>::partial_cmp(self, other)
|
|
|
|
|
}
|
|
|
|
|
}
|
2019-12-22 23:42:04 +01:00
|
|
|
|
};
|
2016-02-18 15:03:42 +01:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl_cmp!(OsString, OsStr);
|
|
|
|
|
impl_cmp!(OsString, &'a OsStr);
|
|
|
|
|
impl_cmp!(Cow<'a, OsStr>, OsStr);
|
|
|
|
|
impl_cmp!(Cow<'a, OsStr>, &'b OsStr);
|
|
|
|
|
impl_cmp!(Cow<'a, OsStr>, OsString);
|
|
|
|
|
|
2015-02-18 05:48:07 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
|
impl Hash for OsStr {
|
|
|
|
|
#[inline]
|
|
|
|
|
fn hash<H: Hasher>(&self, state: &mut H) {
|
|
|
|
|
self.bytes().hash(state)
|
|
|
|
|
}
|
|
|
|
|
}
|
2015-01-22 00:55:31 +01:00
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2017-06-12 21:21:53 +02:00
|
|
|
|
impl fmt::Debug for OsStr {
|
2019-03-01 09:34:11 +01:00
|
|
|
|
fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
|
2017-06-12 21:21:53 +02:00
|
|
|
|
fmt::Debug::fmt(&self.inner, formatter)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl OsStr {
|
2019-03-01 09:34:11 +01:00
|
|
|
|
pub(crate) fn display(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
|
2017-06-12 21:21:53 +02:00
|
|
|
|
fmt::Display::fmt(&self.inner, formatter)
|
2015-01-22 00:55:31 +01:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-02-12 08:16:32 +01:00
|
|
|
|
impl Borrow<OsStr> for OsString {
|
2019-12-22 23:42:04 +01:00
|
|
|
|
fn borrow(&self) -> &OsStr {
|
|
|
|
|
&self[..]
|
|
|
|
|
}
|
2015-01-22 00:55:31 +01:00
|
|
|
|
}
|
|
|
|
|
|
2015-03-02 19:46:05 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-02-12 08:16:32 +01:00
|
|
|
|
impl ToOwned for OsStr {
|
|
|
|
|
type Owned = OsString;
|
2017-04-13 11:48:46 +02:00
|
|
|
|
fn to_owned(&self) -> OsString {
|
|
|
|
|
self.to_os_string()
|
|
|
|
|
}
|
|
|
|
|
fn clone_into(&self, target: &mut OsString) {
|
2020-03-20 23:46:40 +01:00
|
|
|
|
self.inner.clone_into(&mut target.inner)
|
2017-04-13 11:48:46 +02:00
|
|
|
|
}
|
2015-01-22 00:55:31 +01:00
|
|
|
|
}
|
|
|
|
|
|
2015-03-18 17:14:54 +01:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
|
impl AsRef<OsStr> for OsStr {
|
|
|
|
|
fn as_ref(&self) -> &OsStr {
|
|
|
|
|
self
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
|
impl AsRef<OsStr> for OsString {
|
2020-01-10 20:06:18 +01:00
|
|
|
|
#[inline]
|
2015-03-18 17:14:54 +01:00
|
|
|
|
fn as_ref(&self) -> &OsStr {
|
|
|
|
|
self
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
|
impl AsRef<OsStr> for str {
|
2019-12-09 11:39:57 +01:00
|
|
|
|
#[inline]
|
2015-03-18 17:14:54 +01:00
|
|
|
|
fn as_ref(&self) -> &OsStr {
|
2015-07-24 03:04:55 +02:00
|
|
|
|
OsStr::from_inner(Slice::from_str(self))
|
2015-03-18 17:14:54 +01:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
|
|
|
|
impl AsRef<OsStr> for String {
|
2019-12-09 11:39:57 +01:00
|
|
|
|
#[inline]
|
2015-03-18 17:14:54 +01:00
|
|
|
|
fn as_ref(&self) -> &OsStr {
|
2015-07-24 03:04:55 +02:00
|
|
|
|
(&**self).as_ref()
|
2015-03-18 17:14:54 +01:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-01-22 00:55:31 +01:00
|
|
|
|
impl FromInner<Buf> for OsString {
|
|
|
|
|
fn from_inner(buf: Buf) -> OsString {
|
|
|
|
|
OsString { inner: buf }
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl IntoInner<Buf> for OsString {
|
|
|
|
|
fn into_inner(self) -> Buf {
|
|
|
|
|
self.inner
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl AsInner<Slice> for OsStr {
|
2019-04-04 10:51:18 +02:00
|
|
|
|
#[inline]
|
2015-01-22 00:55:31 +01:00
|
|
|
|
fn as_inner(&self) -> &Slice {
|
|
|
|
|
&self.inner
|
|
|
|
|
}
|
|
|
|
|
}
|
2016-02-12 18:21:57 +01:00
|
|
|
|
|
|
|
|
|
#[cfg(test)]
|
|
|
|
|
mod tests {
|
|
|
|
|
use super::*;
|
2019-02-10 20:23:21 +01:00
|
|
|
|
use crate::sys_common::{AsInner, IntoInner};
|
2016-02-12 18:21:57 +01:00
|
|
|
|
|
2019-02-10 20:23:21 +01:00
|
|
|
|
use crate::rc::Rc;
|
|
|
|
|
use crate::sync::Arc;
|
2017-11-14 20:31:07 +01:00
|
|
|
|
|
2016-02-12 18:21:57 +01:00
|
|
|
|
#[test]
|
|
|
|
|
fn test_os_string_with_capacity() {
|
|
|
|
|
let os_string = OsString::with_capacity(0);
|
|
|
|
|
assert_eq!(0, os_string.inner.into_inner().capacity());
|
|
|
|
|
|
|
|
|
|
let os_string = OsString::with_capacity(10);
|
|
|
|
|
assert_eq!(10, os_string.inner.into_inner().capacity());
|
|
|
|
|
|
|
|
|
|
let mut os_string = OsString::with_capacity(0);
|
|
|
|
|
os_string.push("abc");
|
|
|
|
|
assert!(os_string.inner.into_inner().capacity() >= 3);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn test_os_string_clear() {
|
|
|
|
|
let mut os_string = OsString::from("abc");
|
|
|
|
|
assert_eq!(3, os_string.inner.as_inner().len());
|
|
|
|
|
|
|
|
|
|
os_string.clear();
|
|
|
|
|
assert_eq!(&os_string, "");
|
|
|
|
|
assert_eq!(0, os_string.inner.as_inner().len());
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn test_os_string_capacity() {
|
|
|
|
|
let os_string = OsString::with_capacity(0);
|
|
|
|
|
assert_eq!(0, os_string.capacity());
|
|
|
|
|
|
|
|
|
|
let os_string = OsString::with_capacity(10);
|
|
|
|
|
assert_eq!(10, os_string.capacity());
|
|
|
|
|
|
|
|
|
|
let mut os_string = OsString::with_capacity(0);
|
|
|
|
|
os_string.push("abc");
|
|
|
|
|
assert!(os_string.capacity() >= 3);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn test_os_string_reserve() {
|
|
|
|
|
let mut os_string = OsString::new();
|
|
|
|
|
assert_eq!(os_string.capacity(), 0);
|
|
|
|
|
|
|
|
|
|
os_string.reserve(2);
|
|
|
|
|
assert!(os_string.capacity() >= 2);
|
|
|
|
|
|
|
|
|
|
for _ in 0..16 {
|
|
|
|
|
os_string.push("a");
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
assert!(os_string.capacity() >= 16);
|
|
|
|
|
os_string.reserve(16);
|
|
|
|
|
assert!(os_string.capacity() >= 32);
|
|
|
|
|
|
|
|
|
|
os_string.push("a");
|
|
|
|
|
|
|
|
|
|
os_string.reserve(16);
|
|
|
|
|
assert!(os_string.capacity() >= 33)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn test_os_string_reserve_exact() {
|
|
|
|
|
let mut os_string = OsString::new();
|
|
|
|
|
assert_eq!(os_string.capacity(), 0);
|
|
|
|
|
|
|
|
|
|
os_string.reserve_exact(2);
|
|
|
|
|
assert!(os_string.capacity() >= 2);
|
|
|
|
|
|
|
|
|
|
for _ in 0..16 {
|
|
|
|
|
os_string.push("a");
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
assert!(os_string.capacity() >= 16);
|
|
|
|
|
os_string.reserve_exact(16);
|
|
|
|
|
assert!(os_string.capacity() >= 32);
|
|
|
|
|
|
|
|
|
|
os_string.push("a");
|
|
|
|
|
|
|
|
|
|
os_string.reserve_exact(16);
|
|
|
|
|
assert!(os_string.capacity() >= 33)
|
|
|
|
|
}
|
|
|
|
|
|
2016-03-21 17:45:08 +01:00
|
|
|
|
#[test]
|
|
|
|
|
fn test_os_string_default() {
|
|
|
|
|
let os_string: OsString = Default::default();
|
|
|
|
|
assert_eq!("", &os_string);
|
|
|
|
|
}
|
|
|
|
|
|
2016-02-12 18:21:57 +01:00
|
|
|
|
#[test]
|
|
|
|
|
fn test_os_str_is_empty() {
|
|
|
|
|
let mut os_string = OsString::new();
|
|
|
|
|
assert!(os_string.is_empty());
|
|
|
|
|
|
|
|
|
|
os_string.push("abc");
|
|
|
|
|
assert!(!os_string.is_empty());
|
|
|
|
|
|
|
|
|
|
os_string.clear();
|
|
|
|
|
assert!(os_string.is_empty());
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn test_os_str_len() {
|
|
|
|
|
let mut os_string = OsString::new();
|
|
|
|
|
assert_eq!(0, os_string.len());
|
|
|
|
|
|
|
|
|
|
os_string.push("abc");
|
|
|
|
|
assert_eq!(3, os_string.len());
|
|
|
|
|
|
|
|
|
|
os_string.clear();
|
|
|
|
|
assert_eq!(0, os_string.len());
|
|
|
|
|
}
|
2016-03-21 17:45:36 +01:00
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn test_os_str_default() {
|
|
|
|
|
let os_str: &OsStr = Default::default();
|
|
|
|
|
assert_eq!("", os_str);
|
|
|
|
|
}
|
2017-02-01 04:46:16 +01:00
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn into_boxed() {
|
|
|
|
|
let orig = "Hello, world!";
|
|
|
|
|
let os_str = OsStr::new(orig);
|
2017-02-14 02:37:42 +01:00
|
|
|
|
let boxed: Box<OsStr> = Box::from(os_str);
|
|
|
|
|
let os_string = os_str.to_owned().into_boxed_os_str().into_os_string();
|
|
|
|
|
assert_eq!(os_str, &*boxed);
|
|
|
|
|
assert_eq!(&*boxed, &*os_string);
|
|
|
|
|
assert_eq!(&*os_string, os_str);
|
2017-02-01 04:46:16 +01:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn boxed_default() {
|
|
|
|
|
let boxed = <Box<OsStr>>::default();
|
|
|
|
|
assert!(boxed.is_empty());
|
|
|
|
|
}
|
2017-04-13 11:48:46 +02:00
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn test_os_str_clone_into() {
|
|
|
|
|
let mut os_string = OsString::with_capacity(123);
|
|
|
|
|
os_string.push("hello");
|
|
|
|
|
let os_str = OsStr::new("bonjour");
|
|
|
|
|
os_str.clone_into(&mut os_string);
|
|
|
|
|
assert_eq!(os_str, os_string);
|
|
|
|
|
assert!(os_string.capacity() >= 123);
|
|
|
|
|
}
|
2017-11-14 20:31:07 +01:00
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn into_rc() {
|
|
|
|
|
let orig = "Hello, world!";
|
|
|
|
|
let os_str = OsStr::new(orig);
|
|
|
|
|
let rc: Rc<OsStr> = Rc::from(os_str);
|
|
|
|
|
let arc: Arc<OsStr> = Arc::from(os_str);
|
|
|
|
|
|
|
|
|
|
assert_eq!(&*rc, os_str);
|
|
|
|
|
assert_eq!(&*arc, os_str);
|
|
|
|
|
|
|
|
|
|
let rc2: Rc<OsStr> = Rc::from(os_str.to_owned());
|
|
|
|
|
let arc2: Arc<OsStr> = Arc::from(os_str.to_owned());
|
|
|
|
|
|
|
|
|
|
assert_eq!(&*rc2, os_str);
|
|
|
|
|
assert_eq!(&*arc2, os_str);
|
|
|
|
|
}
|
2016-02-12 18:21:57 +01:00
|
|
|
|
}
|