mirror of
https://github.com/fluencelabs/wasmer
synced 2025-05-17 21:01:19 +00:00
116 lines
44 KiB
HTML
116 lines
44 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="API documentation for the Rust `Linkage` enum in crate `inkwell`."><meta name="keywords" content="rust, rustlang, rust-lang, Linkage"><title>inkwell::module::Linkage - Rust</title><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="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc enum"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../inkwell/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Enum Linkage</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Appending">Appending</a><a href="#variant.AvailableExternally">AvailableExternally</a><a href="#variant.Common">Common</a><a href="#variant.DLLExport">DLLExport</a><a href="#variant.DLLImport">DLLImport</a><a href="#variant.External">External</a><a href="#variant.ExternalWeak">ExternalWeak</a><a href="#variant.Ghost">Ghost</a><a href="#variant.Internal">Internal</a><a href="#variant.LinkerPrivate">LinkerPrivate</a><a href="#variant.LinkerPrivateWeak">LinkerPrivateWeak</a><a href="#variant.LinkOnceAny">LinkOnceAny</a><a href="#variant.LinkOnceODRAutoHide">LinkOnceODRAutoHide</a><a href="#variant.LinkOnceODR">LinkOnceODR</a><a href="#variant.Private">Private</a><a href="#variant.WeakAny">WeakAny</a><a href="#variant.WeakODR">WeakODR</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Copy">Copy</a><a href="#impl-Debug">Debug</a><a href="#impl-Eq">Eq</a><a href="#impl-Ord">Ord</a><a href="#impl-PartialEq%3CLinkage%3E">PartialEq<Linkage></a><a href="#impl-PartialOrd%3CLinkage%3E">PartialOrd<Linkage></a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class='location'><a href='../index.html'>inkwell</a>::<wbr><a href='index.html'>module</a></p><script>window.sidebarCurrent = {name: 'Linkage', ty: 'enum', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placehold
|
|||
|
|
Appending,
|
|||
|
|
AvailableExternally,
|
|||
|
|
Common,
|
|||
|
|
DLLExport,
|
|||
|
|
DLLImport,
|
|||
|
|
External,
|
|||
|
|
ExternalWeak,
|
|||
|
|
Ghost,
|
|||
|
|
Internal,
|
|||
|
|
LinkerPrivate,
|
|||
|
|
LinkerPrivateWeak,
|
|||
|
|
LinkOnceAny,
|
|||
|
|
LinkOnceODRAutoHide,
|
|||
|
|
LinkOnceODR,
|
|||
|
|
Private,
|
|||
|
|
WeakAny,
|
|||
|
|
WeakODR,
|
|||
|
|
}</pre></div><div class='docblock'><p>This enum defines how to link a global variable or function in a module. The variant documenation is
|
|||
|
|
mostly taken straight from LLVM's own documentation except for some minor clarification.</p>
|
|||
|
|
<p>It is illegal for a function declaration to have any linkage type other than external or extern_weak.</p>
|
|||
|
|
<p>All Global Variables, Functions and Aliases can have one of the following DLL storage class: <code>DLLImport</code>
|
|||
|
|
& <code>DLLExport</code>.</p>
|
|||
|
|
</div><h2 id='variants' class='variants small-section-header'>
|
|||
|
|
Variants<a href='#variants' class='anchor'></a></h2>
|
|||
|
|
<span id="variant.Appending" class="variant small-section-header"><a href="#variant.Appending" class="anchor field"></a><code id='Appending.v'>Appending</code></span><div class='docblock'><p><code>Appending</code> linkage may only be applied to global variables of pointer to array type. When two global
|
|||
|
|
variables with appending linkage are linked together, the two global arrays are appended together.
|
|||
|
|
This is the LLVM, typesafe, equivalent of having the system linker append together "sections" with
|
|||
|
|
identical names when .o files are linked. Unfortunately this doesn't correspond to any feature in .o
|
|||
|
|
files, so it can only be used for variables like llvm.global_ctors which llvm interprets specially.</p>
|
|||
|
|
</div><span id="variant.AvailableExternally" class="variant small-section-header"><a href="#variant.AvailableExternally" class="anchor field"></a><code id='AvailableExternally.v'>AvailableExternally</code></span><div class='docblock'><p>Globals with <code>AvailableExternally</code> linkage are never emitted into the object file corresponding to
|
|||
|
|
the LLVM module. From the linker's perspective, an <code>AvailableExternally</code> global is equivalent to an
|
|||
|
|
external declaration. They exist to allow inlining and other optimizations to take place given
|
|||
|
|
knowledge of the definition of the global, which is known to be somewhere outside the module. Globals
|
|||
|
|
with <code>AvailableExternally</code> linkage are allowed to be discarded at will, and allow inlining and other
|
|||
|
|
optimizations. This linkage type is only allowed on definitions, not declarations.</p>
|
|||
|
|
</div><span id="variant.Common" class="variant small-section-header"><a href="#variant.Common" class="anchor field"></a><code id='Common.v'>Common</code></span><div class='docblock'><p><code>Common</code> linkage is most similar to "weak" linkage, but they are used for tentative definitions
|
|||
|
|
in C, such as "int X;" at global scope. Symbols with Common linkage are merged in the same way as
|
|||
|
|
weak symbols, and they may not be deleted if unreferenced. <code>Common</code> symbols may not have an explicit
|
|||
|
|
section, must have a zero initializer, and may not be marked 'constant'. Functions and aliases may
|
|||
|
|
not have <code>Common</code> linkage.</p>
|
|||
|
|
</div><span id="variant.DLLExport" class="variant small-section-header"><a href="#variant.DLLExport" class="anchor field"></a><code id='DLLExport.v'>DLLExport</code></span><div class='docblock'><p><code>DLLExport</code> causes the compiler to provide a global pointer to a pointer in a DLL, so that it can be
|
|||
|
|
referenced with the dllimport attribute. On Microsoft Windows targets, the pointer name is formed by
|
|||
|
|
combining _<em>imp</em> and the function or variable name. Since this storage class exists for defining a dll
|
|||
|
|
interface, the compiler, assembler and linker know it is externally referenced and must refrain from
|
|||
|
|
deleting the symbol.</p>
|
|||
|
|
</div><span id="variant.DLLImport" class="variant small-section-header"><a href="#variant.DLLImport" class="anchor field"></a><code id='DLLImport.v'>DLLImport</code></span><div class='docblock'><p><code>DLLImport</code> causes the compiler to reference a function or variable via a global pointer to a pointer
|
|||
|
|
that is set up by the DLL exporting the symbol. On Microsoft Windows targets, the pointer name is
|
|||
|
|
formed by combining _<em>imp</em> and the function or variable name.</p>
|
|||
|
|
</div><span id="variant.External" class="variant small-section-header"><a href="#variant.External" class="anchor field"></a><code id='External.v'>External</code></span><div class='docblock'><p>If none of the other identifiers are used, the global is externally visible, meaning that it
|
|||
|
|
participates in linkage and can be used to resolve external symbol references.</p>
|
|||
|
|
</div><span id="variant.ExternalWeak" class="variant small-section-header"><a href="#variant.ExternalWeak" class="anchor field"></a><code id='ExternalWeak.v'>ExternalWeak</code></span><div class='docblock'><p>The semantics of this linkage follow the ELF object file model: the symbol is weak until linked,
|
|||
|
|
if not linked, the symbol becomes null instead of being an undefined reference.</p>
|
|||
|
|
</div><span id="variant.Ghost" class="variant small-section-header"><a href="#variant.Ghost" class="anchor field"></a><code id='Ghost.v'>Ghost</code></span><div class='docblock'><p>FIXME: Unknown linkage type</p>
|
|||
|
|
</div><span id="variant.Internal" class="variant small-section-header"><a href="#variant.Internal" class="anchor field"></a><code id='Internal.v'>Internal</code></span><div class='docblock'><p>Similar to private, but the value shows as a local symbol (STB_LOCAL in the case of ELF) in the object
|
|||
|
|
file. This corresponds to the notion of the 'static' keyword in C.</p>
|
|||
|
|
</div><span id="variant.LinkerPrivate" class="variant small-section-header"><a href="#variant.LinkerPrivate" class="anchor field"></a><code id='LinkerPrivate.v'>LinkerPrivate</code></span><div class='docblock'><p>FIXME: Unknown linkage type</p>
|
|||
|
|
</div><span id="variant.LinkerPrivateWeak" class="variant small-section-header"><a href="#variant.LinkerPrivateWeak" class="anchor field"></a><code id='LinkerPrivateWeak.v'>LinkerPrivateWeak</code></span><div class='docblock'><p>FIXME: Unknown linkage type</p>
|
|||
|
|
</div><span id="variant.LinkOnceAny" class="variant small-section-header"><a href="#variant.LinkOnceAny" class="anchor field"></a><code id='LinkOnceAny.v'>LinkOnceAny</code></span><div class='docblock'><p>Globals with <code>LinkOnceAny</code> linkage are merged with other globals of the same name when linkage occurs.
|
|||
|
|
This can be used to implement some forms of inline functions, templates, or other code which must be
|
|||
|
|
generated in each translation unit that uses it, but where the body may be overridden with a more
|
|||
|
|
definitive definition later. Unreferenced <code>LinkOnceAny</code> globals are allowed to be discarded. Note that
|
|||
|
|
<code>LinkOnceAny</code> linkage does not actually allow the optimizer to inline the body of this function into
|
|||
|
|
callers because it doesn’t know if this definition of the function is the definitive definition within
|
|||
|
|
the program or whether it will be overridden by a stronger definition. To enable inlining and other
|
|||
|
|
optimizations, use <code>LinkOnceODR</code> linkage.</p>
|
|||
|
|
</div><span id="variant.LinkOnceODRAutoHide" class="variant small-section-header"><a href="#variant.LinkOnceODRAutoHide" class="anchor field"></a><code id='LinkOnceODRAutoHide.v'>LinkOnceODRAutoHide</code></span><div class='docblock'><p>FIXME: Unknown linkage type</p>
|
|||
|
|
</div><span id="variant.LinkOnceODR" class="variant small-section-header"><a href="#variant.LinkOnceODR" class="anchor field"></a><code id='LinkOnceODR.v'>LinkOnceODR</code></span><div class='docblock'><p>Some languages allow differing globals to be merged, such as two functions with different semantics.
|
|||
|
|
Other languages, such as C++, ensure that only equivalent globals are ever merged (the "one definition
|
|||
|
|
rule" — "ODR"). Such languages can use the <code>LinkOnceODR</code> and <code>WeakODR</code> linkage types to indicate that
|
|||
|
|
the global will only be merged with equivalent globals. These linkage types are otherwise the same
|
|||
|
|
as their non-odr versions.</p>
|
|||
|
|
</div><span id="variant.Private" class="variant small-section-header"><a href="#variant.Private" class="anchor field"></a><code id='Private.v'>Private</code></span><div class='docblock'><p>Global values with <code>Private</code> linkage are only directly accessible by objects in the current module.
|
|||
|
|
In particular, linking code into a module with a private global value may cause the private to be
|
|||
|
|
renamed as necessary to avoid collisions. Because the symbol is private to the module, all references
|
|||
|
|
can be updated. This doesn’t show up in any symbol table in the object file.</p>
|
|||
|
|
</div><span id="variant.WeakAny" class="variant small-section-header"><a href="#variant.WeakAny" class="anchor field"></a><code id='WeakAny.v'>WeakAny</code></span><div class='docblock'><p><code>WeakAny</code> linkage has the same merging semantics as linkonce linkage, except that unreferenced globals
|
|||
|
|
with weak linkage may not be discarded. This is used for globals that are declared WeakAny in C source code.</p>
|
|||
|
|
</div><span id="variant.WeakODR" class="variant small-section-header"><a href="#variant.WeakODR" class="anchor field"></a><code id='WeakODR.v'>WeakODR</code></span><div class='docblock'><p>Some languages allow differing globals to be merged, such as two functions with different semantics.
|
|||
|
|
Other languages, such as C++, ensure that only equivalent globals are ever merged (the "one definition
|
|||
|
|
rule" — "ODR"). Such languages can use the <code>LinkOnceODR</code> and <code>WeakODR</code> linkage types to indicate that
|
|||
|
|
the global will only be merged with equivalent globals. These linkage types are otherwise the same
|
|||
|
|
as their non-odr versions.</p>
|
|||
|
|
</div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Eq' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a></code><a href='#impl-Eq' class='anchor'></a><a class='srclink' href='../../src/inkwell/support/mod.rs.html#161' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Clone' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a></code><a href='#impl-Clone' class='anchor'></a><a class='srclink' href='../../src/inkwell/support/mod.rs.html#161' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.clone' class="method hidden"><code id='clone.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a></code><a class='srclink' href='../../src/inkwell/support/mod.rs.html#161' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
|||
|
|
</div><h4 id='method.clone_from' class="method hidden"><code id='clone_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#131-133' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-PartialOrd%3CLinkage%3E' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a><<a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a>> for <a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a></code><a href='#impl-PartialOrd%3CLinkage%3E' class='anchor'></a><a class='srclink' href='../../src/inkwell/support/mod.rs.html#161' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.partial_cmp' class="method hidden"><code id='partial_cmp.v'>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp' class='fnname'>partial_cmp</a>(&self, other: &<a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a>></code><a class='srclink' href='../../src/inkwell/support/mod.rs.html#161' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method returns an ordering between <code>self</code> and <code>other</code> values if one exists. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#tymethod.partial_cmp">Read more</a></p>
|
|||
|
|
</div><h4 id='method.lt' class="method hidden"><code id='lt.v'><span class="docblock attributes">#[must_use]
|
|||
|
|
</span>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt' class='fnname'>lt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#793-798' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests less than (for <code>self</code> and <code>other</code>) and is used by the <code><</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.lt">Read more</a></p>
|
|||
|
|
</div><h4 id='method.le' class="method hidden"><code id='le.v'><span class="docblock attributes">#[must_use]
|
|||
|
|
</span>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le' class='fnname'>le</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#815-820' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests less than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code><=</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.le">Read more</a></p>
|
|||
|
|
</div><h4 id='method.gt' class="method hidden"><code id='gt.v'><span class="docblock attributes">#[must_use]
|
|||
|
|
</span>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt' class='fnname'>gt</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#836-841' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests greater than (for <code>self</code> and <code>other</code>) and is used by the <code>></code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.gt">Read more</a></p>
|
|||
|
|
</div><h4 id='method.ge' class="method hidden"><code id='ge.v'><span class="docblock attributes">#[must_use]
|
|||
|
|
</span>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge' class='fnname'>ge</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#858-863' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests greater than or equal to (for <code>self</code> and <code>other</code>) and is used by the <code>>=</code> operator. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html#method.ge">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-Ord' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a> for <a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a></code><a href='#impl-Ord' class='anchor'></a><a class='srclink' href='../../src/inkwell/support/mod.rs.html#161' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.cmp' class="method hidden"><code id='cmp.v'>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#tymethod.cmp' class='fnname'>cmp</a>(&self, other: &<a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a></code><a class='srclink' href='../../src/inkwell/support/mod.rs.html#161' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method returns an <code>Ordering</code> between <code>self</code> and <code>other</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#tymethod.cmp">Read more</a></p>
|
|||
|
|
</div><h4 id='method.max' class="method hidden"><code id='max.v'>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.max' class='fnname'>max</a>(self, other: Self) -> Self</code><span class='since' title='Stable since Rust version 1.21.0'>1.21.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#563-566' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Compares and returns the maximum of two values. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.max">Read more</a></p>
|
|||
|
|
</div><h4 id='method.min' class="method hidden"><code id='min.v'>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.min' class='fnname'>min</a>(self, other: Self) -> Self</code><span class='since' title='Stable since Rust version 1.21.0'>1.21.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#580-583' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Compares and returns the minimum of two values. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.min">Read more</a></p>
|
|||
|
|
</div><h4 id='method.clamp' class="method hidden"><code id='clamp.v'>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.clamp' class='fnname'>clamp</a>(self, min: Self, max: Self) -> Self</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#604-614' title='goto source code'>[src]</a></h4><div class='stability hidden'><div class='stab unstable'><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>clamp</code>)</div></div><div class='docblock hidden'><p>Restrict a value to a certain interval. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html#method.clamp">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-PartialEq%3CLinkage%3E' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a>> for <a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a></code><a href='#impl-PartialEq%3CLinkage%3E' class='anchor'></a><a class='srclink' href='../../src/inkwell/support/mod.rs.html#161' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.eq' class="method hidden"><code id='eq.v'>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, other: &<a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/inkwell/support/mod.rs.html#161' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
|||
|
|
</div><h4 id='method.ne' class="method hidden"><code id='ne.v'><span class="docblock attributes">#[must_use]
|
|||
|
|
</span>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#200' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>!=</code>.</p>
|
|||
|
|
</div></div><h3 id='impl-Copy' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a></code><a href='#impl-Copy' class='anchor'></a><a class='srclink' href='../../src/inkwell/support/mod.rs.html#161' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Debug' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../../src/inkwell/support/mod.rs.html#161' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class='srclink' href='../../src/inkwell/support/mod.rs.html#161' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
|||
|
|
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Sync' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Send' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="enum" href="../../inkwell/module/enum.Linkage.html" title="enum inkwell::module::Linkage">Linkage</a></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#543-548' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#545-547' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|||
|
|
</div></div><h3 id='impl-ToOwned' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code><a href='#impl-ToOwned' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#81-92' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Owned' class="type"><code id='Owned.t'>type <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned' class="type">Owned</a> = T</code></h4><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
|||
|
|
</div><h4 id='method.to_owned' class="method hidden"><code id='to_owned.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned' class='fnname'>to_owned</a>(&self) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#85-87' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
|||
|
|
</div><h4 id='method.clone_into' class="method hidden"><code id='clone_into.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into' class='fnname'>clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#89-91' title='goto source code'>[src]</a></h4><div class='stability hidden'><div class='stab unstable'><details><summary><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
|
|||
|
|
</details></div></div><div class='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#552-554' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|||
|
|
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#571-577' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|||
|
|
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#574-576' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|||
|
|
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#559-566' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|||
|
|
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#563-565' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|||
|
|
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
|||
|
|
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "inkwell";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|