ssw/doc/os_str_bytes/trait.RawOsStrCow.html
2023-01-09 19:23:20 +01:00

26 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Extensions to `Cow&lt;RawOsStr&gt;` for additional conversions."><meta name="keywords" content="rust, rustlang, rust-lang, RawOsStrCow"><title>RawOsStrCow 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">&#9776;</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="#">RawOsStrCow</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.into_os_str">into_os_str</a></li><li><a href="#tymethod.into_raw_bytes">into_raw_bytes</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-RawOsStrCow%3C%27a%3E-for-Cow%3C%27a%2C%20RawOsStr%3E">Cow&lt;&#39;a, RawOsStr&gt;</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="#">RawOsStrCow</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/raw_str.rs.html#918-959">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait RawOsStrCow&lt;'a&gt;: Sealed {
fn <a href="#tymethod.into_os_str" class="fnname">into_os_str</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.64.0/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'a, <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsStr.html" title="struct std::ffi::os_str::OsStr">OsStr</a>&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.into_raw_bytes" class="fnname">into_raw_bytes</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.64.0/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'a, [<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>]&gt;;
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Extensions to <a href="https://doc.rust-lang.org/1.64.0/alloc/borrow/enum.Cow.html"><code>Cow&lt;RawOsStr&gt;</code></a> for additional conversions.</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.into_os_str" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/os_str_bytes/raw_str.rs.html#937">source</a></div><h4 class="code-header">fn <a href="#tymethod.into_os_str" class="fnname">into_os_str</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.64.0/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'a, <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsStr.html" title="struct std::ffi::os_str::OsStr">OsStr</a>&gt;</h4></div></summary><div class="docblock"><p>Converts this representation back to a platform-native string.</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">os_str_bytes::RawOsStr</span>;
<span class="kw">use</span> <span class="ident">os_str_bytes::RawOsStrCow</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="ident">into_os_string</span>();
<span class="kw">let</span> <span class="ident">raw</span> <span class="op">=</span> <span class="ident">RawOsStr::new</span>(<span class="kw-2">&amp;</span><span class="ident">os_string</span>);
<span class="macro">assert_eq!</span>(<span class="ident">os_string</span>, <span class="ident">raw</span>.<span class="ident">into_os_str</span>());</code></pre></div>
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.into_raw_bytes" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/os_str_bytes/raw_str.rs.html#958">source</a></div><h4 class="code-header">fn <a href="#tymethod.into_raw_bytes" class="fnname">into_raw_bytes</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.64.0/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'a, [<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>]&gt;</h4></div></summary><div class="docblock"><p>Returns the byte string stored by this container.</p>
<p>The returned string will use an <a href="index.html#encoding">unspecified encoding</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::borrow::Cow</span>;
<span class="kw">use</span> <span class="ident">os_str_bytes::RawOsStr</span>;
<span class="kw">use</span> <span class="ident">os_str_bytes::RawOsStrCow</span>;
<span class="kw">let</span> <span class="ident">string</span> <span class="op">=</span> <span class="string">&quot;foobar&quot;</span>;
<span class="kw">let</span> <span class="ident">raw</span> <span class="op">=</span> <span class="ident">Cow::Borrowed</span>(<span class="ident">RawOsStr::from_str</span>(<span class="ident">string</span>));
<span class="macro">assert_eq!</span>(<span class="ident">string</span>.<span class="ident">as_bytes</span>(), <span class="kw-2">&amp;</span><span class="kw-2">*</span><span class="ident">raw</span>.<span class="ident">into_raw_bytes</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-RawOsStrCow%3C%27a%3E-for-Cow%3C%27a%2C%20RawOsStr%3E" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/os_str_bytes/raw_str.rs.html#961-977">source</a></span><a href="#impl-RawOsStrCow%3C%27a%3E-for-Cow%3C%27a%2C%20RawOsStr%3E" class="anchor"></a><h3 class="code-header in-band">impl&lt;'a&gt; <a class="trait" href="trait.RawOsStrCow.html" title="trait os_str_bytes::RawOsStrCow">RawOsStrCow</a>&lt;'a&gt; for <a class="enum" href="https://doc.rust-lang.org/1.64.0/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'a, <a class="struct" href="struct.RawOsStr.html" title="struct os_str_bytes::RawOsStr">RawOsStr</a>&gt;</h3></section></summary><div class="impl-items"><section id="method.into_os_str" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/os_str_bytes/raw_str.rs.html#963-968">source</a></span><a href="#method.into_os_str" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.into_os_str" class="fnname">into_os_str</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.64.0/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'a, <a class="struct" href="https://doc.rust-lang.org/1.64.0/std/ffi/os_str/struct.OsStr.html" title="struct std::ffi::os_str::OsStr">OsStr</a>&gt;</h4></section><section id="method.into_raw_bytes" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/os_str_bytes/raw_str.rs.html#971-976">source</a></span><a href="#method.into_raw_bytes" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.into_raw_bytes" class="fnname">into_raw_bytes</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.64.0/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'a, [<a class="primitive" href="https://doc.rust-lang.org/1.64.0/std/primitive.u8.html">u8</a>]&gt;</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/raw_str/trait.RawOsStrCow.js" data-ignore-extern-crates="alloc" 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>