| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/foreign-types-0.3.2/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../foreign_types/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../foreign_types/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><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"><a href="../../help.html">?</a></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><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! A framework for Rust wrappers over C APIs. |
| //! |
| //! Ownership is as important in C as it is in Rust, but the semantics are often implicit. In |
| //! particular, pointer-to-value is commonly used to pass C values both when transferring ownership |
| //! or a borrow. |
| //! |
| //! This crate provides a framework to define a Rust wrapper over these kinds of raw C APIs in a way |
| //! that allows ownership semantics to be expressed in an ergonomic manner. The framework takes a |
| //! dual-type approach similar to APIs in the standard library such as `PathBuf`/`Path` or `String`/ |
| //! `str`. One type represents an owned value and references to the other represent borrowed |
| //! values. |
| //! |
| //! # Examples |
| //! |
| //! ``` |
| //! use foreign_types::{ForeignType, ForeignTypeRef, Opaque}; |
| //! use std::ops::{Deref, DerefMut}; |
| //! |
| //! mod foo_sys { |
| //! pub enum FOO {} |
| //! |
| //! extern { |
| //! pub fn FOO_free(foo: *mut FOO); |
| //! } |
| //! } |
| //! |
| //! // The borrowed type is a newtype wrapper around an `Opaque` value. |
| //! // |
| //! // `FooRef` values never exist; we instead create references to `FooRef`s |
| //! // from raw C pointers. |
| //! pub struct FooRef(Opaque); |
| //! |
| //! impl ForeignTypeRef for FooRef { |
| //! type CType = foo_sys::FOO; |
| //! } |
| //! |
| //! // The owned type is simply a newtype wrapper around the raw C type. |
| //! // |
| //! // It dereferences to `FooRef`, so methods that do not require ownership |
| //! // should be defined there. |
| //! pub struct Foo(*mut foo_sys::FOO); |
| //! |
| //! impl Drop for Foo { |
| //! fn drop(&mut self) { |
| //! unsafe { foo_sys::FOO_free(self.0) } |
| //! } |
| //! } |
| //! |
| //! impl ForeignType for Foo { |
| //! type CType = foo_sys::FOO; |
| //! type Ref = FooRef; |
| //! |
| //! unsafe fn from_ptr(ptr: *mut foo_sys::FOO) -> Foo { |
| //! Foo(ptr) |
| //! } |
| //! |
| //! fn as_ptr(&self) -> *mut foo_sys::FOO { |
| //! self.0 |
| //! } |
| //! } |
| //! |
| //! impl Deref for Foo { |
| //! type Target = FooRef; |
| //! |
| //! fn deref(&self) -> &FooRef { |
| //! unsafe { FooRef::from_ptr(self.0) } |
| //! } |
| //! } |
| //! |
| //! impl DerefMut for Foo { |
| //! fn deref_mut(&mut self) -> &mut FooRef { |
| //! unsafe { FooRef::from_ptr_mut(self.0) } |
| //! } |
| //! } |
| //! ``` |
| //! |
| //! The `foreign_type!` macro can generate this boilerplate for you: |
| //! |
| //! ``` |
| //! #[macro_use] |
| //! extern crate foreign_types; |
| //! |
| //! mod foo_sys { |
| //! pub enum FOO {} |
| //! |
| //! extern { |
| //! pub fn FOO_free(foo: *mut FOO); |
| //! pub fn FOO_duplicate(foo: *mut FOO) -> *mut FOO; // Optional |
| //! } |
| //! } |
| //! |
| //! foreign_type! { |
| //! type CType = foo_sys::FOO; |
| //! fn drop = foo_sys::FOO_free; |
| //! fn clone = foo_sys::FOO_duplicate; // Optional |
| //! /// A Foo. |
| //! pub struct Foo; |
| //! /// A borrowed Foo. |
| //! pub struct FooRef; |
| //! } |
| //! |
| //! # fn main() {} |
| //! ``` |
| //! |
| //! If `fn clone` is specified, then it must take `CType` as an argument and return a copy of it as `CType`. |
| //! It will be used to implement `ToOwned` and `Clone`. |
| //! |
| //! `#[derive(…)] is permitted before the lines with `pub struct`. |
| //! `#[doc(hidden)]` before the `type CType` line will hide the `foreign_type!` implementations from documentation. |
| //! |
| //! Say we then have a separate type in our C API that contains a `FOO`: |
| //! |
| //! ``` |
| //! mod foo_sys { |
| //! pub enum FOO {} |
| //! pub enum BAR {} |
| //! |
| //! extern { |
| //! pub fn FOO_free(foo: *mut FOO); |
| //! pub fn BAR_free(bar: *mut BAR); |
| //! pub fn BAR_get_foo(bar: *mut BAR) -> *mut FOO; |
| //! } |
| //! } |
| //! ``` |
| //! |
| //! The documentation for the C library states that `BAR_get_foo` returns a reference into the `BAR` |
| //! passed to it, which translates into a reference in Rust. It also says that we're allowed to |
| //! modify the `FOO`, so we'll define a pair of accessor methods, one immutable and one mutable: |
| //! |
| //! ``` |
| //! #[macro_use] |
| //! extern crate foreign_types; |
| //! |
| //! use foreign_types::ForeignTypeRef; |
| //! |
| //! mod foo_sys { |
| //! pub enum FOO {} |
| //! pub enum BAR {} |
| //! |
| //! extern { |
| //! pub fn FOO_free(foo: *mut FOO); |
| //! pub fn BAR_free(bar: *mut BAR); |
| //! pub fn BAR_get_foo(bar: *mut BAR) -> *mut FOO; |
| //! } |
| //! } |
| //! |
| //! foreign_type! { |
| //! #[doc(hidden)] |
| //! type CType = foo_sys::FOO; |
| //! fn drop = foo_sys::FOO_free; |
| //! /// A Foo. |
| //! pub struct Foo; |
| //! /// A borrowed Foo. |
| //! pub struct FooRef; |
| //! } |
| //! |
| //! foreign_type! { |
| //! type CType = foo_sys::BAR; |
| //! fn drop = foo_sys::BAR_free; |
| //! /// A Foo. |
| //! pub struct Bar; |
| //! /// A borrowed Bar. |
| //! pub struct BarRef; |
| //! } |
| //! |
| //! impl BarRef { |
| //! fn foo(&self) -> &FooRef { |
| //! unsafe { FooRef::from_ptr(foo_sys::BAR_get_foo(self.as_ptr())) } |
| //! } |
| //! |
| //! fn foo_mut(&mut self) -> &mut FooRef { |
| //! unsafe { FooRef::from_ptr_mut(foo_sys::BAR_get_foo(self.as_ptr())) } |
| //! } |
| //! } |
| //! |
| //! # fn main() {} |
| //! ``` |
| </span><span class="attribute">#![no_std] |
| #![warn(missing_docs)] |
| #![doc(html_root_url=<span class="string">"https://docs.rs/foreign-types/0.3"</span>)] |
| </span><span class="kw">extern crate </span>foreign_types_shared; |
| |
| <span class="attribute">#[doc(inline)] |
| </span><span class="kw">pub use </span>foreign_types_shared::<span class="kw-2">*</span>; |
| |
| <span class="doccomment">/// A macro to easily define wrappers for foreign types. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// #[macro_use] |
| /// extern crate foreign_types; |
| /// |
| /// # mod openssl_sys { pub type SSL = (); pub unsafe fn SSL_free(_: *mut SSL) {} pub unsafe fn SSL_dup(x: *mut SSL) -> *mut SSL {x} } |
| /// foreign_type! { |
| /// type CType = openssl_sys::SSL; |
| /// fn drop = openssl_sys::SSL_free; |
| /// fn clone = openssl_sys::SSL_dup; |
| /// /// Documentation for the owned type. |
| /// pub struct Ssl; |
| /// /// Documentation for the borrowed type. |
| /// pub struct SslRef; |
| /// } |
| /// |
| /// # fn main() {} |
| /// ``` |
| </span><span class="attribute">#[macro_export] |
| </span><span class="macro">macro_rules! </span>foreign_type { |
| ( |
| $(<span class="attribute">#[<span class="macro-nonterminal">$impl_attr</span>:meta]</span>)* |
| <span class="kw">type </span>CType = <span class="macro-nonterminal">$ctype</span>:ty; |
| <span class="kw">fn </span>drop = <span class="macro-nonterminal">$drop</span>:expr; |
| $(<span class="kw">fn </span>clone = <span class="macro-nonterminal">$clone</span>:expr;)* |
| $(<span class="attribute">#[<span class="macro-nonterminal">$owned_attr</span>:meta]</span>)* |
| <span class="kw">pub struct </span><span class="macro-nonterminal">$owned</span>:ident; |
| $(<span class="attribute">#[<span class="macro-nonterminal">$borrowed_attr</span>:meta]</span>)* |
| <span class="kw">pub struct </span><span class="macro-nonterminal">$borrowed</span>:ident; |
| ) => { |
| $(<span class="attribute">#[<span class="macro-nonterminal">$owned_attr</span>]</span>)* |
| <span class="kw">pub struct </span><span class="macro-nonterminal">$owned</span>(<span class="kw-2">*mut </span><span class="macro-nonterminal">$ctype</span>); |
| |
| $(<span class="attribute">#[<span class="macro-nonterminal">$impl_attr</span>]</span>)* |
| <span class="kw">impl </span><span class="macro-nonterminal">$crate::ForeignType </span><span class="kw">for </span><span class="macro-nonterminal">$owned </span>{ |
| <span class="kw">type </span>CType = <span class="macro-nonterminal">$ctype</span>; |
| <span class="kw">type </span>Ref = <span class="macro-nonterminal">$borrowed</span>; |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">unsafe fn </span>from_ptr(ptr: <span class="kw-2">*mut </span><span class="macro-nonterminal">$ctype</span>) -> <span class="macro-nonterminal">$owned </span>{ |
| <span class="macro-nonterminal">$owned</span>(ptr) |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>as_ptr(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">*mut </span><span class="macro-nonterminal">$ctype </span>{ |
| <span class="self">self</span>.<span class="number">0 |
| </span>} |
| } |
| |
| <span class="kw">impl </span>Drop <span class="kw">for </span><span class="macro-nonterminal">$owned </span>{ |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="kw">unsafe </span>{ <span class="macro-nonterminal">$drop</span>(<span class="self">self</span>.<span class="number">0</span>) } |
| } |
| } |
| |
| $( |
| <span class="kw">impl </span>Clone <span class="kw">for </span><span class="macro-nonterminal">$owned </span>{ |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>clone(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="macro-nonterminal">$owned </span>{ |
| <span class="kw">unsafe </span>{ |
| <span class="kw">let </span>handle: <span class="kw-2">*mut </span><span class="macro-nonterminal">$ctype </span>= <span class="macro-nonterminal">$clone</span>(<span class="self">self</span>.<span class="number">0</span>); |
| <span class="macro-nonterminal">$crate::ForeignType::from_ptr</span>(handle) |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>::std::borrow::ToOwned <span class="kw">for </span><span class="macro-nonterminal">$borrowed </span>{ |
| <span class="kw">type </span>Owned = <span class="macro-nonterminal">$owned</span>; |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>to_owned(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="macro-nonterminal">$owned </span>{ |
| <span class="kw">unsafe </span>{ |
| <span class="kw">let </span>handle: <span class="kw-2">*mut </span><span class="macro-nonterminal">$ctype </span>= <span class="macro-nonterminal">$clone</span>(<span class="macro-nonterminal">$crate::ForeignTypeRef::as_ptr</span>(<span class="self">self</span>)); |
| <span class="macro-nonterminal">$crate::ForeignType::from_ptr</span>(handle) |
| } |
| } |
| } |
| )* |
| |
| <span class="kw">impl </span>::std::ops::Deref <span class="kw">for </span><span class="macro-nonterminal">$owned </span>{ |
| <span class="kw">type </span>Target = <span class="macro-nonterminal">$borrowed</span>; |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>deref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="macro-nonterminal">$borrowed </span>{ |
| <span class="kw">unsafe </span>{ <span class="macro-nonterminal">$crate::ForeignTypeRef::from_ptr</span>(<span class="self">self</span>.<span class="number">0</span>) } |
| } |
| } |
| |
| <span class="kw">impl </span>::std::ops::DerefMut <span class="kw">for </span><span class="macro-nonterminal">$owned </span>{ |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>deref_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span><span class="macro-nonterminal">$borrowed </span>{ |
| <span class="kw">unsafe </span>{ <span class="macro-nonterminal">$crate::ForeignTypeRef::from_ptr_mut</span>(<span class="self">self</span>.<span class="number">0</span>) } |
| } |
| } |
| |
| <span class="kw">impl </span>::std::borrow::Borrow<<span class="macro-nonterminal">$borrowed</span>> <span class="kw">for </span><span class="macro-nonterminal">$owned </span>{ |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>borrow(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="macro-nonterminal">$borrowed </span>{ |
| <span class="kw-2">&**</span><span class="self">self |
| </span>} |
| } |
| |
| <span class="kw">impl </span>::std::convert::AsRef<<span class="macro-nonterminal">$borrowed</span>> <span class="kw">for </span><span class="macro-nonterminal">$owned </span>{ |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="macro-nonterminal">$borrowed </span>{ |
| <span class="kw-2">&**</span><span class="self">self |
| </span>} |
| } |
| |
| $(<span class="attribute">#[<span class="macro-nonterminal">$borrowed_attr</span>]</span>)* |
| <span class="kw">pub struct </span><span class="macro-nonterminal">$borrowed</span>(<span class="macro-nonterminal">$crate::Opaque</span>); |
| |
| $(<span class="attribute">#[<span class="macro-nonterminal">$impl_attr</span>]</span>)* |
| <span class="kw">impl </span><span class="macro-nonterminal">$crate::ForeignTypeRef </span><span class="kw">for </span><span class="macro-nonterminal">$borrowed </span>{ |
| <span class="kw">type </span>CType = <span class="macro-nonterminal">$ctype</span>; |
| } |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="foreign_types" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |