47 lines
19 KiB
HTML
47 lines
19 KiB
HTML
<!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="A platform agnostic variant of `OsStringExt`."><meta name="keywords" content="rust, rustlang, rust-lang, OsStringBytes"><title>OsStringBytes in os_str_bytes - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../os_str_bytes/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../os_str_bytes/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">OsStringBytes</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.assert_from_raw_vec">assert_from_raw_vec</a></li><li><a href="#tymethod.from_raw_vec">from_raw_vec</a></li><li><a href="#tymethod.into_raw_vec">into_raw_vec</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul><li><a href="#impl-OsStringBytes-for-OsString">OsString</a></li><li><a href="#impl-OsStringBytes-for-PathBuf">PathBuf</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In os_str_bytes</a></h2></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../os_str_bytes/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Trait <a href="index.html">os_str_bytes</a>::<wbr><a class="trait" href="#">OsStringBytes</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/os_str_bytes/lib.rs.html#478-562">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait OsStringBytes: Sealed + <a class="trait" href="https://doc.rust-lang.org/1.64.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
fn <a href="#tymethod.assert_from_raw_vec" class="fnname">assert_from_raw_vec</a>(string: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>>) -> Self;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.from_raw_vec" class="fnname">from_raw_vec</a>(string: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.EncodingError.html" title="struct os_str_bytes::EncodingError">EncodingError</a>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.into_raw_vec" class="fnname">into_raw_vec</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>>;
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A platform agnostic variant of <a href="https://doc.rust-lang.org/1.64.0/std/os/unix/ffi/os_str/trait.OsStringExt.html"><code>OsStringExt</code></a>.</p>
|
||
<p>For more information, see <a href="index.html">the module-level documentation</a>.</p>
|
||
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.assert_from_raw_vec" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/os_str_bytes/lib.rs.html#505">source</a></div><h4 class="code-header">fn <a href="#tymethod.assert_from_raw_vec" class="fnname">assert_from_raw_vec</a>(string: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>>) -> Self</h4></div></summary><div class="docblock"><p>Converts a byte string into an equivalent platform-native string.</p>
|
||
<h5 id="panics"><a href="#panics">Panics</a></h5>
|
||
<p>Panics if the string is not valid for the <a href="index.html#encoding">unspecified encoding</a> used
|
||
by this crate.</p>
|
||
<h5 id="examples"><a href="#examples">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::env</span>;
|
||
<span class="kw">use</span> <span class="ident">std::ffi::OsString</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">os_str_bytes::OsStringBytes</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">os_string</span> <span class="op">=</span> <span class="ident">env::current_exe</span>()<span class="question-mark">?</span>;
|
||
<span class="kw">let</span> <span class="ident">os_bytes</span> <span class="op">=</span> <span class="ident">os_string</span>.<span class="ident">clone</span>().<span class="ident">into_raw_vec</span>();
|
||
<span class="macro">assert_eq!</span>(<span class="ident">os_string</span>, <span class="ident">OsString::assert_from_raw_vec</span>(<span class="ident">os_bytes</span>));</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.from_raw_vec" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/os_str_bytes/lib.rs.html#540">source</a></div><h4 class="code-header">fn <a href="#tymethod.from_raw_vec" class="fnname">from_raw_vec</a>(string: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.EncodingError.html" title="struct os_str_bytes::EncodingError">EncodingError</a>></h4></div></summary><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span> Deprecated: <p>use <code>assert_from_raw_vec</code> instead, or enable the ‘checked_conversions’ feature</p>
|
||
</div></span><div class="docblock"><p>Converts a byte string into an equivalent platform-native string.</p>
|
||
<p><a href="trait.OsStringBytes.html#tymethod.assert_from_raw_vec"><code>assert_from_raw_vec</code></a> should almost always be used instead. For
|
||
more information, see <a href="struct.EncodingError.html" title="EncodingError"><code>EncodingError</code></a>.</p>
|
||
<h5 id="errors"><a href="#errors">Errors</a></h5>
|
||
<p>See documentation for <a href="struct.EncodingError.html" title="EncodingError"><code>EncodingError</code></a>.</p>
|
||
<h5 id="examples-1"><a href="#examples-1">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::env</span>;
|
||
<span class="kw">use</span> <span class="ident">std::ffi::OsString</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">os_str_bytes::OsStringBytes</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">os_string</span> <span class="op">=</span> <span class="ident">env::current_exe</span>()<span class="question-mark">?</span>;
|
||
<span class="kw">let</span> <span class="ident">os_bytes</span> <span class="op">=</span> <span class="ident">os_string</span>.<span class="ident">clone</span>().<span class="ident">into_raw_vec</span>();
|
||
<span class="macro">assert_eq!</span>(<span class="ident">os_string</span>, <span class="ident">OsString::from_raw_vec</span>(<span class="ident">os_bytes</span>).<span class="ident">unwrap</span>());</code></pre></div>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.into_raw_vec" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/os_str_bytes/lib.rs.html#561">source</a></div><h4 class="code-header">fn <a href="#tymethod.into_raw_vec" class="fnname">into_raw_vec</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>></h4></div></summary><div class="docblock"><p>Converts a platform-native string into an equivalent byte string.</p>
|
||
<p>The returned string will use an <a href="index.html#encoding">unspecified encoding</a>.</p>
|
||
<h5 id="examples-2"><a href="#examples-2">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::ffi::OsString</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">os_str_bytes::OsStringBytes</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">string</span> <span class="op">=</span> <span class="string">"foobar"</span>.<span class="ident">to_owned</span>();
|
||
<span class="kw">let</span> <span class="ident">os_string</span>: <span class="ident">OsString</span> <span class="op">=</span> <span class="ident">string</span>.<span class="ident">clone</span>().<span class="ident">into</span>();
|
||
<span class="macro">assert_eq!</span>(<span class="ident">string</span>.<span class="ident">into_bytes</span>(), <span class="ident">os_string</span>.<span class="ident">into_raw_vec</span>());</code></pre></div>
|
||
</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-OsStringBytes-for-OsString" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/os_str_bytes/lib.rs.html#564-579">source</a></span><a href="#impl-OsStringBytes-for-OsString" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.OsStringBytes.html" title="trait os_str_bytes::OsStringBytes">OsStringBytes</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsString.html" title="struct std::ffi::os_str::OsString">OsString</a></h3></section></summary><div class="impl-items"><section id="method.assert_from_raw_vec" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/os_str_bytes/lib.rs.html#566-568">source</a></span><a href="#method.assert_from_raw_vec" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.assert_from_raw_vec" class="fnname">assert_from_raw_vec</a>(string: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>>) -> Self</h4></section><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_raw_vec" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/os_str_bytes/lib.rs.html#571-573">source</a></span><a href="#method.from_raw_vec" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.from_raw_vec" class="fnname">from_raw_vec</a>(string: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.EncodingError.html" title="struct os_str_bytes::EncodingError">EncodingError</a>></h4></section></summary><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span> Deprecated: <p>use <code>assert_from_raw_vec</code> instead, or enable the ‘checked_conversions’ feature</p>
|
||
</div></span></details><section id="method.into_raw_vec" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/os_str_bytes/lib.rs.html#576-578">source</a></span><a href="#method.into_raw_vec" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.into_raw_vec" class="fnname">into_raw_vec</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-OsStringBytes-for-PathBuf" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/os_str_bytes/lib.rs.html#581-596">source</a></span><a href="#impl-OsStringBytes-for-PathBuf" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.OsStringBytes.html" title="trait os_str_bytes::OsStringBytes">OsStringBytes</a> for <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a></h3></section></summary><div class="impl-items"><section id="method.assert_from_raw_vec-1" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/os_str_bytes/lib.rs.html#583-585">source</a></span><a href="#method.assert_from_raw_vec-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.assert_from_raw_vec" class="fnname">assert_from_raw_vec</a>(string: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>>) -> Self</h4></section><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_raw_vec-1" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/os_str_bytes/lib.rs.html#588-590">source</a></span><a href="#method.from_raw_vec-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.from_raw_vec" class="fnname">from_raw_vec</a>(string: <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>>) -> <a class="enum" href="https://doc.rust-lang.org/1.64.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="struct.EncodingError.html" title="struct os_str_bytes::EncodingError">EncodingError</a>></h4></section></summary><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span> Deprecated: <p>use <code>assert_from_raw_vec</code> instead, or enable the ‘checked_conversions’ feature</p>
|
||
</div></span></details><section id="method.into_raw_vec-1" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/os_str_bytes/lib.rs.html#593-595">source</a></span><a href="#method.into_raw_vec-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.into_raw_vec" class="fnname">into_raw_vec</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/1.64.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../implementors/os_str_bytes/trait.OsStringBytes.js" data-ignore-extern-crates="std" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="os_str_bytes" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |