edlang/git2/trait.IntoCString.html

8 lines
18 KiB
HTML
Raw Normal View History

<!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 class of types that can be converted to C strings."><title>IntoCString in git2 - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="git2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../git2/index.html">git2</a><span class="version">0.18.3</span></h2></div><h2 class="location"><a href="#">IntoCString</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.into_c_string">into_c_string</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-IntoCString-for-%26OsStr">&amp;&#x27;a OsStr</a></li><li><a href="#impl-IntoCString-for-%26Path">&amp;&#x27;a Path</a></li><li><a href="#impl-IntoCString-for-%26T">&amp;&#x27;a T</a></li><li><a href="#impl-IntoCString-for-%26%5Bu8%5D">&amp;&#x27;a [u8]</a></li><li><a href="#impl-IntoCString-for-%26str">&amp;&#x27;a str</a></li><li><a href="#impl-IntoCString-for-CString">CString</a></li><li><a href="#impl-IntoCString-for-OsString">OsString</a></li><li><a href="#impl-IntoCString-for-PathBuf">PathBuf</a></li><li><a href="#impl-IntoCString-for-String">String</a></li><li><a href="#impl-IntoCString-for-Vec%3Cu8%3E">Vec&lt;u8&gt;</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate git2</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="index.html">git2</a>::<wbr><a class="trait" href="#">IntoCString</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/git2/util.rs.html#100-103">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait IntoCString {
// Required method
fn <a href="#tymethod.into_c_string" class="fn">into_c_string</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/ffi/c_str/struct.CString.html" title="struct alloc::ffi::c_str::CString">CString</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>&gt;;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A class of types that can be converted to C strings.</p>
<p>These types are represented internally as byte slices and it is quite rare
for them to contain an interior 0 byte.</p>
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.into_c_string" class="method"><a class="src rightside" href="../src/git2/util.rs.html#102">source</a><h4 class="code-header">fn <a href="#tymethod.into_c_string" class="fn">into_c_string</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/ffi/c_str/struct.CString.html" title="struct alloc::ffi::c_str::CString">CString</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>&gt;</h4></section></summary><div class="docblock"><p>Consume this container, converting it into a CString</p>
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-IntoCString-for-CString" class="impl"><a class="src rightside" href="../src/git2/util.rs.html#123-127">source</a><a href="#impl-IntoCString-for-CString" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoCString.html" title="trait git2::IntoCString">IntoCString</a> for <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/ffi/c_str/struct.CString.html" title="struct alloc::ffi::c_str::CString">CString</a></h3></section></summary><div class="impl-items"><section id="method.into_c_string" class="method trait-impl"><a class="src rightside" href="../src/git2/util.rs.html#124-126">source</a><a href="#method.into_c_string" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.into_c_string" class="fn">into_c_string</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/ffi/c_str/struct.CString.html" title="struct alloc::ffi::c_str::CString">CString</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IntoCString-for-String" class="impl"><a class="src rightside" href="../src/git2/util.rs.html#117-121">source</a><a href="#impl-IntoCString-for-String" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoCString.html" title="trait git2::IntoCString">IntoCString</a> for <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h3></section></summary><div class="impl-items"><section id="method.into_c_string-1" class="method trait-impl"><a class="src rightside" href="../src/git2/util.rs.html#118-120">source</a><a href="#method.into_c_string-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.into_c_string" class="fn">into_c_string</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/ffi/c_str/struct.CString.html" title="struct alloc::ffi::c_str::CString">CString</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IntoCString-for-Vec%3Cu8%3E" class="impl"><a class="src rightside" href="../src/git2/util.rs.html#173-177">source</a><a href="#impl-IntoCString-for-Vec%3Cu8%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IntoCString.html" title="trait git2::IntoCString">IntoCString</a> for <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u8.html">u8</a>&gt;</h3></section></summary><div class="impl-items"><section id="method.into_c_string-2" class="method trait-impl"><a class="src rightside" href="../src/git2/util.rs.html#174-176">source</a><a href="#method.into_c_string-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.into_c_string" class="fn">into_c_string</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/ffi/c_str/struct.CString.html" title="struct alloc::ffi::c_str::CString">CString</a>, <a class="struct" href="struct.Error.html" title="struct git2::Error">Error</a>&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IntoCString-for-OsString" cla