| <!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 trait implemented by types which reference borrowed foreign types."><meta name="keywords" content="rust, rustlang, rust-lang, ForeignTypeRef"><title>ForeignTypeRef in foreign_types_shared - 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" 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="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="../foreign_types_shared/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../foreign_types_shared/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">ForeignTypeRef</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.CType">CType</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.as_ptr">as_ptr</a></li><li><a href="#method.from_ptr">from_ptr</a></li><li><a href="#method.from_ptr_mut">from_ptr_mut</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In foreign_types_shared</a></h2></div></nav><main><div class="width-limiter"><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"><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="main-heading"><h1 class="fqn">Trait <a href="index.html">foreign_types_shared</a>::<wbr><a class="trait" href="#">ForeignTypeRef</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></h1><span class="out-of-band"><a class="srclink" href="../src/foreign_types_shared/lib.rs.html#30-51">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait ForeignTypeRef: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> { |
| type <a href="#associatedtype.CType" class="associatedtype">CType</a>; |
| |
| unsafe fn <a href="#method.from_ptr" class="fnname">from_ptr</a><'a>(ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.pointer.html">*mut </a>Self::<a class="associatedtype" href="trait.ForeignTypeRef.html#associatedtype.CType" title="type foreign_types_shared::ForeignTypeRef::CType">CType</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.reference.html">&'a </a>Self { ... } |
| <span class="item-spacer"></span> unsafe fn <a href="#method.from_ptr_mut" class="fnname">from_ptr_mut</a><'a>(ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.pointer.html">*mut </a>Self::<a class="associatedtype" href="trait.ForeignTypeRef.html#associatedtype.CType" title="type foreign_types_shared::ForeignTypeRef::CType">CType</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.reference.html">&'a mut </a>Self { ... } |
| <span class="item-spacer"></span> fn <a href="#method.as_ptr" class="fnname">as_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.pointer.html">*mut </a>Self::<a class="associatedtype" href="trait.ForeignTypeRef.html#associatedtype.CType" title="type foreign_types_shared::ForeignTypeRef::CType">CType</a> { ... } |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait implemented by types which reference borrowed foreign types.</p> |
| </div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.CType" class="method has-srclink"><a class="srclink rightside" href="../src/foreign_types_shared/lib.rs.html#32">source</a><h4 class="code-header">type <a href="#associatedtype.CType" class="associatedtype">CType</a></h4></section></summary><div class="docblock"><p>The raw C type.</p> |
| </div></details></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_ptr" class="method has-srclink"><a class="srclink rightside" href="../src/foreign_types_shared/lib.rs.html#36-38">source</a><h4 class="code-header">unsafe fn <a href="#method.from_ptr" class="fnname">from_ptr</a><'a>(ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.pointer.html">*mut </a>Self::<a class="associatedtype" href="trait.ForeignTypeRef.html#associatedtype.CType" title="type foreign_types_shared::ForeignTypeRef::CType">CType</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.reference.html">&'a </a>Self</h4></section></summary><div class="docblock"><p>Constructs a shared instance of this type from its raw type.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_ptr_mut" class="method has-srclink"><a class="srclink rightside" href="../src/foreign_types_shared/lib.rs.html#42-44">source</a><h4 class="code-header">unsafe fn <a href="#method.from_ptr_mut" class="fnname">from_ptr_mut</a><'a>(ptr: <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.pointer.html">*mut </a>Self::<a class="associatedtype" href="trait.ForeignTypeRef.html#associatedtype.CType" title="type foreign_types_shared::ForeignTypeRef::CType">CType</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.reference.html">&'a mut </a>Self</h4></section></summary><div class="docblock"><p>Constructs a mutable reference of this type from its raw type.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_ptr" class="method has-srclink"><a class="srclink rightside" href="../src/foreign_types_shared/lib.rs.html#48-50">source</a><h4 class="code-header">fn <a href="#method.as_ptr" class="fnname">as_ptr</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/core/primitive.pointer.html">*mut </a>Self::<a class="associatedtype" href="trait.ForeignTypeRef.html#associatedtype.CType" title="type foreign_types_shared::ForeignTypeRef::CType">CType</a></h4></section></summary><div class="docblock"><p>Returns a raw pointer to the wrapped value.</p> |
| </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"></div><script src="../implementors/foreign_types_shared/trait.ForeignTypeRef.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="foreign_types_shared" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
