OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Rollup merge of #42198 - GuillaumeGomez:os-str-doc, r=QuietMisdreavus

Browse Source 
Add missing urls for OsStr docs

r? @rust-lang/docs
This commit is contained in:
Mark Simulacrum 2017-05-24 19:50:10 -06:00 committed by GitHub
commit 2bca4fa47d
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/libstd/ffi/os_str.rs
View File

@ -247,7 +247,9 @@ impl OsString {
self.inner.shrink_to_fit()
}
/// Converts this `OsString` into a boxed `OsStr`.
/// Converts this `OsString` into a boxed [`OsStr`].
///
/// [`OsStr`]: struct.OsStr.html
///
/// # Examples
///
@ -482,12 +484,13 @@ impl OsStr {
/// Returns the length of this `OsStr`.
///
/// Note that this does **not** return the number of bytes in this string
/// as, for example, OS strings on Windows are encoded as a list of `u16`
/// as, for example, OS strings on Windows are encoded as a list of [`u16`]
/// rather than a list of bytes. This number is simply useful for passing to
/// other methods like [`OsString::with_capacity`] to avoid reallocations.
///
/// See `OsStr` introduction for more information about encoding.
///
/// [`u16`]: ../primitive.u16.html
/// [`OsString::with_capacity`]: struct.OsString.html#method.with_capacity
///
/// # Examples
@ -506,7 +509,10 @@ impl OsStr {
self.inner.inner.len()
}
/// Converts a `Box<OsStr>` into an `OsString` without copying or allocating.
/// Converts a [`Box`]`<OsStr>` into an [`OsString`] without copying or allocating.
///
/// [`Box`]: ../boxed/struct.Box.html
/// [`OsString`]: struct.OsString.html
#[unstable(feature = "into_boxed_os_str", issue = "40380")]
pub fn into_os_string(self: Box<OsStr>) -> OsString {
let inner: Box<Slice> = unsafe { mem::transmute(self) };