<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="generator" content="rustdoc"> <meta name="description" content="API documentation for the Rust `OsStrExt` trait in crate `std`."> <meta name="keywords" content="rust, rustlang, rust-lang, OsStrExt"> <title>std::os::unix::ffi::OsStrExt - Rust</title> <link rel="stylesheet" type="text/css" href="../../../../normalize.css"> <link rel="stylesheet" type="text/css" href="../../../../rustdoc.css" id="mainThemeStyle"> <link rel="stylesheet" type="text/css" href="../../../../dark.css"> <link rel="stylesheet" type="text/css" href="../../../../main.css" id="themeStyle"> <script src="../../../../storage.js"></script> <link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico"> </head> <body class="rustdoc trait"> <!--[if lte IE 8]> <div class="warning"> This old browser is unsupported and will most likely display funky things. </div> <![endif]--> <nav class="sidebar"> <div class="sidebar-menu">☰</div> <a href='../../../../std/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a> <p class='location'>Trait OsStrExt</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.from_bytes">from_bytes</a><a href="#tymethod.as_bytes">as_bytes</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../../../index.html'>std</a>::<wbr><a href='../../index.html'>os</a>::<wbr><a href='../index.html'>unix</a>::<wbr><a href='index.html'>ffi</a></p><script>window.sidebarCurrent = {name: 'OsStrExt', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div> </nav> <div class="theme-picker"> <button id="theme-picker" aria-label="Pick another theme!"> <img src="../../../../brush.svg" width="18" alt="Pick another theme!"> </button> <div id="theme-choices"></div> </div> <script src="../../../../theme.js"></script> <nav class="sub"> <form class="search-form js-only"> <div class="search-container"> <input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"> </div> </form> </nav> <section id='main' class="content"> <h1 class='fqn'><span class='in-band'>Trait <a href='../../../index.html'>std</a>::<wbr><a href='../../index.html'>os</a>::<wbr><a href='../index.html'>unix</a>::<wbr><a href='index.html'>ffi</a>::<wbr><a class="trait" href=''>OsStrExt</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><span id='render-detail'> <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs"> [<span class='inner'>−</span>] </a> </span><a class='srclink' href='../../../../src/std/sys/unix/ext/ffi.rs.html#71-105' title='goto source code'>[src]</a></span></h1> <pre class='rust trait'>pub trait OsStrExt { fn <a href='#tymethod.from_bytes' class='fnname'>from_bytes</a>(slice: <a class="primitive" href="../../../primitive.slice.html">&[</a><a class="primitive" href="../../../primitive.u8.html">u8</a><a class="primitive" href="../../../primitive.slice.html">]</a>) -> <a class="primitive" href="../../../primitive.reference.html">&</a>Self; <div class='item-spacer'></div> fn <a href='#tymethod.as_bytes' class='fnname'>as_bytes</a>(&self) -> <a class="primitive" href="../../../primitive.slice.html">&[</a><a class="primitive" href="../../../primitive.u8.html">u8</a><a class="primitive" href="../../../primitive.slice.html">]</a>; }</pre><div class='stability'><div class='stab portability'>This is supported on <strong>Unix</strong> only.</div></div><div class='docblock'><p>Unix-specific extensions to <code>OsStr</code>.</p> </div> <h2 id='required-methods' class='small-section-header'> Required Methods<a href='#required-methods' class='anchor'></a> </h2> <div class='methods'> <div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="../../../primitive.reference.html">&'a mut </a>I</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="../../../primitive.reference.html">&'a mut </a>I</h3><code class="content"><span class="where fmt-newline">impl<'a, I> <a class="trait" href="../../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a> for <a class="primitive" href="../../../primitive.reference.html">&'a mut </a>I <span class="where fmt-newline">where<br> I: <a class="trait" href="../../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a> + ?<a class="trait" href="../../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>, </span></span><span class="where fmt-newline"> type <a href='../../../../std/iter/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="../../../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a>>::<a class="type" href="../../../../std/iter/trait.Iterator.html#associatedtype.Item" title="type std::iter::Iterator::Item">Item</a>;</span><span class="where fmt-newline">impl<'a, R: <a class="trait" href="../../../../std/io/trait.Read.html" title="trait std::io::Read">Read</a> + ?<a class="trait" href="../../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>> <a class="trait" href="../../../../std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="../../../primitive.reference.html">&'a mut </a>R</span><span class="where fmt-newline">impl<'a, W: <a class="trait" href="../../../../std/io/trait.Write.html" title="trait std::io::Write">Write</a> + ?<a class="trait" href="../../../../std/marker/trait.Sized.html" title="trait std::marker::Sized">Sized</a>> <a class="trait" href="../../../../std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="../../../primitive.reference.html">&'a mut </a>W</span></code></div></div><h3 id='tymethod.from_bytes' class='method'><span id='from_bytes.v' class='invisible'><code>fn <a href='#tymethod.from_bytes' class='fnname'>from_bytes</a>(slice: <a class="primitive" href="../../../primitive.slice.html">&[</a><a class="primitive" href="../../../primitive.u8.html">u8</a><a class="primitive" href="../../../primitive.slice.html">]</a>) -> <a class="primitive" href="../../../primitive.reference.html">&</a>Self</code></span></h3><div class='stability'><div class='stab portability'>This is supported on <strong>Unix</strong> only.</div></div><div class='docblock'><p>Creates an <a href="../../../ffi/struct.OsStr.html"><code>OsStr</code></a> from a byte slice.</p> <h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1> <pre class="rust rust-example-rendered"> <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ffi</span>::<span class="ident">OsStr</span>; <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">unix</span>::<span class="ident">ffi</span>::<span class="ident">OsStrExt</span>; <span class="kw">let</span> <span class="ident">bytes</span> <span class="op">=</span> <span class="string">b"foo"</span>; <span class="kw">let</span> <span class="ident">os_str</span> <span class="op">=</span> <span class="ident">OsStr</span>::<span class="ident">from_bytes</span>(<span class="ident">bytes</span>); <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">os_str</span>.<span class="ident">to_str</span>(), <span class="prelude-val">Some</span>(<span class="string">"foo"</span>));<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Affi%3A%3AOsStr%3B%0Ause%20std%3A%3Aos%3A%3Aunix%3A%3Affi%3A%3AOsStrExt%3B%0A%0Alet%20bytes%20%3D%20b%22foo%22%3B%0Alet%20os_str%20%3D%20OsStr%3A%3Afrom_bytes(bytes)%3B%0Aassert_eq!(os_str.to_str()%2C%20Some(%22foo%22))%3B%0A%7D">Run</a></pre> </div><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="primitive" href="../../../primitive.slice.html">&'a [</a><a class="primitive" href="../../../primitive.u8.html">u8</a><a class="primitive" href="../../../primitive.slice.html">]</a></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="primitive" href="../../../primitive.slice.html">&'a [</a><a class="primitive" href="../../../primitive.u8.html">u8</a><a class="primitive" href="../../../primitive.slice.html">]</a></h3><code class="content"><span class="where fmt-newline">impl<'a> <a class="trait" href="../../../../std/io/trait.Read.html" title="trait std::io::Read">Read</a> for <a class="primitive" href="../../../primitive.slice.html">&'a [</a><a class="primitive" href="../../../primitive.u8.html">u8</a><a class="primitive" href="../../../primitive.slice.html">]</a></span><span class="where fmt-newline">impl<'a> <a class="trait" href="../../../../std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="primitive" href="../../../primitive.slice.html">&'a mut [</a><a class="primitive" href="../../../primitive.u8.html">u8</a><a class="primitive" href="../../../primitive.slice.html">]</a></span></code></div></div><h3 id='tymethod.as_bytes' class='method'><span id='as_bytes.v' class='invisible'><code>fn <a href='#tymethod.as_bytes' class='fnname'>as_bytes</a>(&self) -> <a class="primitive" href="../../../primitive.slice.html">&[</a><a class="primitive" href="../../../primitive.u8.html">u8</a><a class="primitive" href="../../../primitive.slice.html">]</a></code></span></h3><div class='stability'><div class='stab portability'>This is supported on <strong>Unix</strong> only.</div></div><div class='docblock'><p>Gets the underlying byte view of the <a href="../../../ffi/struct.OsStr.html"><code>OsStr</code></a> slice.</p> <h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1> <pre class="rust rust-example-rendered"> <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ffi</span>::<span class="ident">OsStr</span>; <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">os</span>::<span class="ident">unix</span>::<span class="ident">ffi</span>::<span class="ident">OsStrExt</span>; <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">os_str</span> <span class="op">=</span> <span class="ident">OsStr</span>::<span class="ident">new</span>(<span class="string">"foo"</span>); <span class="kw">let</span> <span class="ident">bytes</span> <span class="op">=</span> <span class="ident">os_str</span>.<span class="ident">as_bytes</span>(); <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">bytes</span>, <span class="string">b"foo"</span>);<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Affi%3A%3AOsStr%3B%0Ause%20std%3A%3Aos%3A%3Aunix%3A%3Affi%3A%3AOsStrExt%3B%0A%0Alet%20mut%20os_str%20%3D%20OsStr%3A%3Anew(%22foo%22)%3B%0Alet%20bytes%20%3D%20os_str.as_bytes()%3B%0Aassert_eq!(bytes%2C%20b%22foo%22)%3B%0A%7D">Run</a></pre> </div></div> <h2 id='implementors' class='small-section-header'> Implementors<a href='#implementors' class='anchor'></a> </h2> <ul class='item-list' id='implementors-list'> <li><div class='out-of-band'><a class='srclink' href='../../../../src/std/sys/unix/ext/ffi.rs.html#108-115' title='goto source code'>[src]</a></div><code>impl OsStrExt for <a class="struct" href="../../../../std/ffi/struct.OsStr.html" title="struct std::ffi::OsStr">OsStr</a></code></li> </ul><script type="text/javascript" async src="../../../../implementors/std/os/unix/ffi/trait.OsStrExt.js"> </script></section> <section id='search' class="content hidden"></section> <section class="footer"></section> <aside id="help" class="hidden"> <div> <h1 class="hidden">Help</h1> <div class="shortcuts"> <h2>Keyboard Shortcuts</h2> <dl> <dt><kbd>?</kbd></dt> <dd>Show this help dialog</dd> <dt><kbd>S</kbd></dt> <dd>Focus the search field</dd> <dt><kbd>↑</kbd></dt> <dd>Move up in search results</dd> <dt><kbd>↓</kbd></dt> <dd>Move down in search results</dd> <dt><kbd>↹</kbd></dt> <dd>Switch tab</dd> <dt><kbd>⏎</kbd></dt> <dd>Go to active search result</dd> <dt><kbd>+</kbd></dt> <dd>Expand all sections</dd> <dt><kbd>-</kbd></dt> <dd>Collapse all sections</dd> </dl> </div> <div class="infos"> <h2>Search Tricks</h2> <p> Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type. </p> <p> Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>. </p> <p> Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>) </p> </div> </div> </aside> <script> window.rootPath = "../../../../"; window.currentCrate = "std"; </script> <script src="../../../../main.js"></script> <script defer src="../../../../search-index.js"></script> </body> </html>