ffi.rs.html -- source
Description: Source to the Rust file `libstd/sys/unix/ext/ffi.rs`.
Keywords: rust, rustlang, rust-lang

      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119

    // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    //! Unix-specific extension to the primitives in the `std::ffi` module

    #![stable(feature = "rust1", since = "1.0.0")]

    use ffi::{OsStr, OsString};
    use mem;
    use sys::os_str::Buf;
    use sys_common::{FromInner, IntoInner, AsInner};

    /// Unix-specific extensions to [`OsString`].
    ///
    /// [`OsString`]: ../../../../std/ffi/struct.OsString.html
    #[stable(feature = "rust1", since = "1.0.0")]
    pub trait OsStringExt {
        /// Creates an [`OsString`] from a byte vector.
        ///
        /// # Examples
        ///
        /// ```
        /// use std::ffi::OsString;
        /// use std::os::unix::ffi::OsStringExt;
        ///
        /// let bytes = b"foo".to_vec();
        /// let os_string = OsString::from_vec(bytes);
        /// assert_eq!(os_string.to_str(), Some("foo"));
        /// ```
        ///
        /// [`OsString`]: ../../../ffi/struct.OsString.html
        #[stable(feature = "rust1", since = "1.0.0")]
        fn from_vec(vec: Vec<u8>) -> Self;

        /// Yields the underlying byte vector of this [`OsString`].
        ///
        /// # Examples
        ///
        /// ```
        /// use std::ffi::OsString;
        /// use std::os::unix::ffi::OsStringExt;
        ///
        /// let mut os_string = OsString::new();
        /// os_string.push("foo");
        /// let bytes = os_string.into_vec();
        /// assert_eq!(bytes, b"foo");
        /// ```
        ///
        /// [`OsString`]: ../../../ffi/struct.OsString.html
        #[stable(feature = "rust1", since = "1.0.0")]
        fn into_vec(self) -> Vec<u8>;
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl OsStringExt for OsString {
        fn from_vec(vec: Vec<u8>) -> OsString {
            FromInner::from_inner(Buf { inner: vec })
        }
        fn into_vec(self) -> Vec<u8> {
            self.into_inner().inner
        }
    }

    /// Unix-specific extensions to [`OsStr`].
    ///
    /// [`OsStr`]: ../../../../std/ffi/struct.OsStr.html
    #[stable(feature = "rust1", since = "1.0.0")]
    pub trait OsStrExt {
        #[stable(feature = "rust1", since = "1.0.0")]
        /// Creates an [`OsStr`] from a byte slice.
        ///
        /// # Examples
        ///
        /// ```
        /// use std::ffi::OsStr;
        /// use std::os::unix::ffi::OsStrExt;
        ///
        /// let bytes = b"foo";
        /// let os_str = OsStr::from_bytes(bytes);
        /// assert_eq!(os_str.to_str(), Some("foo"));
        /// ```
        ///
        /// [`OsStr`]: ../../../ffi/struct.OsStr.html
        fn from_bytes(slice: &[u8]) -> &Self;

        /// Gets the underlying byte view of the [`OsStr`] slice.
        ///
        /// # Examples
        ///
        /// ```
        /// use std::ffi::OsStr;
        /// use std::os::unix::ffi::OsStrExt;
        ///
        /// let mut os_str = OsStr::new("foo");
        /// let bytes = os_str.as_bytes();
        /// assert_eq!(bytes, b"foo");
        /// ```
        ///
        /// [`OsStr`]: ../../../ffi/struct.OsStr.html
        #[stable(feature = "rust1", since = "1.0.0")]
        fn as_bytes(&self) -> &[u8];
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl OsStrExt for OsStr {
        fn from_bytes(slice: &[u8]) -> &OsStr {
            unsafe { mem::transmute(slice) }
        }
        fn as_bytes(&self) -> &[u8] {
            &self.as_inner().inner
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)