Sophie: rust-doc-1.35.0-1.mga7 armv7hl

rust-doc-1.35.0-1.mga7.armv7hl.rpm

<!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 `core` crate."><meta name="keywords" content="rust, rustlang, rust-lang, core"><title>core - Rust</title><link rel="stylesheet" type="text/css" href="../normalize1.35.0.css"><link rel="stylesheet" type="text/css" href="../rustdoc1.35.0.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark1.35.0.css"><link rel="stylesheet" type="text/css" href="../light1.35.0.css" id="themeStyle"><script src="../storage1.35.0.js"></script><noscript><link rel="stylesheet" href="../noscript1.35.0.css"></noscript><link rel="shortcut icon" href="../favicon1.35.0.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow1.35.0.svg");}</style></head><body class="rustdoc mod"><!--[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">&#9776;</div><a href='../core/index.html'><img src='../rust-logo1.35.0.png' alt='logo' width='100'></a><p class='location'>Crate core</p><div class='block version'><p>Version 1.35.0</p></div><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all core's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'core', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush1.35.0.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme1.35.0.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" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel1.35.0.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span class='since' title='Stable since Rust version 1.6.0'>1.6.0</span><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../src/core/lib.rs.html#1-236' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>core</a></span></h1><div class='docblock'><h1 id="the-rust-core-library" class="section-header"><a href="#the-rust-core-library">The Rust Core Library</a></h1>
<p>The Rust Core Library is the dependency-free<sup id="fnref1"><a href="#fn1">1</a></sup> foundation of <a href="../std/index.html">The
Rust Standard Library</a>. It is the portable glue
between the language and its libraries, defining the intrinsic and
primitive building blocks of all Rust code. It links to no
upstream libraries, no system libraries, and no libc.</p>
<p>The core library is <em>minimal</em>: it isn't even aware of heap allocation,
nor does it provide concurrency or I/O. These things require
platform integration, and this library is platform-agnostic.</p>
<h1 id="how-to-use-the-core-library" class="section-header"><a href="#how-to-use-the-core-library">How to use the core library</a></h1>
<p>Please note that all of these details are currently not considered stable.</p>
<p>This library is built on the assumption of a few existing symbols:</p>
<ul>
<li>
<p><code>memcpy</code>, <code>memcmp</code>, <code>memset</code> - These are core memory routines which are
often generated by LLVM. Additionally, this library can make explicit
calls to these functions. Their signatures are the same as found in C.
These functions are often provided by the system libc, but can also be
provided by the <a href="https://crates.io/crates/compiler_builtins">compiler-builtins crate</a>.</p>
</li>
<li>
<p><code>rust_begin_panic</code> - This function takes four arguments, a
<code>fmt::Arguments</code>, a <code>&amp;'static str</code>, and two <code>u32</code>'s. These four arguments
dictate the panic message, the file at which panic was invoked, and the
line and column inside the file. It is up to consumers of this core
library to define this panic function; it is only required to never
return. This requires a <code>lang</code> attribute named <code>panic_impl</code>.</p>
</li>
<li>
<p><code>rust_eh_personality</code> - is used by the failure mechanisms of the
compiler. This is often mapped to GCC's personality function, but crates
which do not trigger a panic can be assured that this function is never
called. The <code>lang</code> attribute is called <code>eh_personality</code>.</p>
</li>
</ul>
<div class="footnotes"><hr><ol><li id="fn1">
<p>Strictly speaking, there are some symbols which are needed but
they aren't always necessary.&nbsp;<a href="#fnref1" rev="footnote">↩</a></p></li></ol></div></div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table><tr class='module-item'><td><a class="mod" href="alloc/index.html" title='core::alloc mod'>alloc</a></td><td class='docblock-short'><p>Memory allocation APIs</p>
</td></tr><tr class='module-item'><td><a class="mod" href="any/index.html" title='core::any mod'>any</a></td><td class='docblock-short'><p>This module implements the <code>Any</code> trait, which enables dynamic typing
of any <code>'static</code> type through runtime reflection.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="arch/index.html" title='core::arch mod'>arch</a></td><td class='docblock-short'><p>SIMD and vendor intrinsics module.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="array/index.html" title='core::array mod'>array</a></td><td class='docblock-short'><p>Implementations of things like <code>Eq</code> for fixed-length arrays
up to a certain length. Eventually we should able to generalize
to all lengths.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="ascii/index.html" title='core::ascii mod'>ascii</a></td><td class='docblock-short'><p>Operations on ASCII strings and characters.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="borrow/index.html" title='core::borrow mod'>borrow</a></td><td class='docblock-short'><p>A module for working with borrowed data.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="cell/index.html" title='core::cell mod'>cell</a></td><td class='docblock-short'><p>Shareable mutable containers.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="char/index.html" title='core::char mod'>char</a></td><td class='docblock-short'><p>A character type.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="clone/index.html" title='core::clone mod'>clone</a></td><td class='docblock-short'><p>The <code>Clone</code> trait for types that cannot be 'implicitly copied'.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="cmp/index.html" title='core::cmp mod'>cmp</a></td><td class='docblock-short'><p>Functionality for ordering and comparison.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="convert/index.html" title='core::convert mod'>convert</a></td><td class='docblock-short'><p>Traits for conversions between types.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="default/index.html" title='core::default mod'>default</a></td><td class='docblock-short'><p>The <code>Default</code> trait for types which may have meaningful default values.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="f32/index.html" title='core::f32 mod'>f32</a></td><td class='docblock-short'><p>This module provides constants which are specific to the implementation
of the <code>f32</code> floating point data type.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="f64/index.html" title='core::f64 mod'>f64</a></td><td class='docblock-short'><p>This module provides constants which are specific to the implementation
of the <code>f64</code> floating point data type.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="ffi/index.html" title='core::ffi mod'>ffi</a></td><td class='docblock-short'><p>Utilities related to FFI bindings.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="fmt/index.html" title='core::fmt mod'>fmt</a></td><td class='docblock-short'><p>Utilities for formatting and printing strings.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="hash/index.html" title='core::hash mod'>hash</a></td><td class='docblock-short'><p>Generic hashing support.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="hint/index.html" title='core::hint mod'>hint</a></td><td class='docblock-short'><p>Hints to compiler that affects how code should be emitted or optimized.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="i8/index.html" title='core::i8 mod'>i8</a></td><td class='docblock-short'><p>The 8-bit signed integer type.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="i16/index.html" title='core::i16 mod'>i16</a></td><td class='docblock-short'><p>The 16-bit signed integer type.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="i32/index.html" title='core::i32 mod'>i32</a></td><td class='docblock-short'><p>The 32-bit signed integer type.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="i64/index.html" title='core::i64 mod'>i64</a></td><td class='docblock-short'><p>The 64-bit signed integer type.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="i128/index.html" title='core::i128 mod'>i128</a></td><td class='docblock-short'><p>The 128-bit signed integer type.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="isize/index.html" title='core::isize mod'>isize</a></td><td class='docblock-short'><p>The pointer-sized signed integer type.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="iter/index.html" title='core::iter mod'>iter</a></td><td class='docblock-short'><p>Composable external iteration.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="marker/index.html" title='core::marker mod'>marker</a></td><td class='docblock-short'><p>Primitive traits and types representing basic properties of types.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="mem/index.html" title='core::mem mod'>mem</a></td><td class='docblock-short'><p>Basic functions for dealing with memory.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="num/index.html" title='core::num mod'>num</a></td><td class='docblock-short'><p>Numeric traits and functions for the built-in numeric types.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="ops/index.html" title='core::ops mod'>ops</a></td><td class='docblock-short'><p>Overloadable operators.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="option/index.html" title='core::option mod'>option</a></td><td class='docblock-short'><p>Optional values.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="pin/index.html" title='core::pin mod'>pin</a></td><td class='docblock-short'><p>Types that pin data to its location in memory.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="prelude/index.html" title='core::prelude mod'>prelude</a></td><td class='docblock-short'><p>The libcore prelude</p>
</td></tr><tr class='module-item'><td><a class="mod" href="ptr/index.html" title='core::ptr mod'>ptr</a></td><td class='docblock-short'><p>Manually manage memory through raw pointers.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="result/index.html" title='core::result mod'>result</a></td><td class='docblock-short'><p>Error handling with the <code>Result</code> type.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="slice/index.html" title='core::slice mod'>slice</a></td><td class='docblock-short'><p>Slice management and manipulation.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="str/index.html" title='core::str mod'>str</a></td><td class='docblock-short'><p>String manipulation.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="sync/index.html" title='core::sync mod'>sync</a></td><td class='docblock-short'><p>Synchronization primitives</p>
</td></tr><tr class='module-item'><td><a class="mod" href="time/index.html" title='core::time mod'>time</a></td><td class='docblock-short'><p>Temporal quantification.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="u8/index.html" title='core::u8 mod'>u8</a></td><td class='docblock-short'><p>The 8-bit unsigned integer type.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="u16/index.html" title='core::u16 mod'>u16</a></td><td class='docblock-short'><p>The 16-bit unsigned integer type.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="u32/index.html" title='core::u32 mod'>u32</a></td><td class='docblock-short'><p>The 32-bit unsigned integer type.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="u64/index.html" title='core::u64 mod'>u64</a></td><td class='docblock-short'><p>The 64-bit unsigned integer type.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="u128/index.html" title='core::u128 mod'>u128</a></td><td class='docblock-short'><p>The 128-bit unsigned integer type.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="usize/index.html" title='core::usize mod'>usize</a></td><td class='docblock-short'><p>The pointer-sized unsigned integer type.</p>
</td></tr><tr class='unstable module-item'><td><a class="mod" href="future/index.html" title='core::future mod'>future</a></td><td class='docblock-short'><span class="stab unstable">Experimental</span><p>Asynchronous values.</p>
</td></tr><tr class='unstable module-item'><td><a class="mod" href="intrinsics/index.html" title='core::intrinsics mod'>intrinsics</a></td><td class='docblock-short'><span class="stab unstable">Experimental</span><p>Compiler intrinsics.</p>
</td></tr><tr class='unstable module-item'><td><a class="mod" href="panic/index.html" title='core::panic mod'>panic</a></td><td class='docblock-short'><span class="stab unstable">Experimental</span><p>Panic support in the standard library.</p>
</td></tr><tr class='unstable module-item'><td><a class="mod" href="panicking/index.html" title='core::panicking mod'>panicking</a></td><td class='docblock-short'><span class="stab unstable">Experimental</span><p>Panic support for libcore</p>
</td></tr><tr class='unstable module-item'><td><a class="mod" href="raw/index.html" title='core::raw mod'>raw</a></td><td class='docblock-short'><span class="stab unstable">Experimental</span><p>Contains struct definitions for the layout of compiler built-in types.</p>
</td></tr><tr class='unstable module-item'><td><a class="mod" href="task/index.html" title='core::task mod'>task</a></td><td class='docblock-short'><span class="stab unstable">Experimental</span><p>Types and Traits for working with asynchronous tasks.</p>
</td></tr><tr class='unstable module-item'><td><a class="mod" href="unicode/index.html" title='core::unicode mod'>unicode</a></td><td class='docblock-short'><span class="stab unstable">Experimental</span></td></tr></table><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2>
<table><tr class='module-item'><td><a class="macro" href="macro.assert.html" title='core::assert macro'>assert</a></td><td class='docblock-short'><p>Asserts that a boolean expression is <code>true</code> at runtime.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.assert_eq.html" title='core::assert_eq macro'>assert_eq</a></td><td class='docblock-short'><p>Asserts that two expressions are equal to each other (using <a href="cmp/trait.PartialEq.html"><code>PartialEq</code></a>).</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.assert_ne.html" title='core::assert_ne macro'>assert_ne</a></td><td class='docblock-short'><p>Asserts that two expressions are not equal to each other (using <a href="cmp/trait.PartialEq.html"><code>PartialEq</code></a>).</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.cfg.html" title='core::cfg macro'>cfg</a></td><td class='docblock-short'><p>Evaluates boolean combinations of configuration flags, at compile-time.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.column.html" title='core::column macro'>column</a></td><td class='docblock-short'><p>Expands to the column number on which it was invoked.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.compile_error.html" title='core::compile_error macro'>compile_error</a></td><td class='docblock-short'><p>Causes compilation to fail with the given error message when encountered.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.concat.html" title='core::concat macro'>concat</a></td><td class='docblock-short'><p>Concatenates literals into a static string slice.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.debug_assert.html" title='core::debug_assert macro'>debug_assert</a></td><td class='docblock-short'><p>Asserts that a boolean expression is <code>true</code> at runtime.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.debug_assert_eq.html" title='core::debug_assert_eq macro'>debug_assert_eq</a></td><td class='docblock-short'><p>Asserts that two expressions are equal to each other.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.debug_assert_ne.html" title='core::debug_assert_ne macro'>debug_assert_ne</a></td><td class='docblock-short'><p>Asserts that two expressions are not equal to each other.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.env.html" title='core::env macro'>env</a></td><td class='docblock-short'><p>Inspects an environment variable at compile time.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.file.html" title='core::file macro'>file</a></td><td class='docblock-short'><p>Expands to the file name from which it was invoked.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.format_args.html" title='core::format_args macro'>format_args</a></td><td class='docblock-short'><p>Constructs parameters for the other string-formatting macros.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.include.html" title='core::include macro'>include</a></td><td class='docblock-short'><p>Parses a file as an expression or an item according to the context.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.include_bytes.html" title='core::include_bytes macro'>include_bytes</a></td><td class='docblock-short'><p>Includes a file as a reference to a byte array.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.include_str.html" title='core::include_str macro'>include_str</a></td><td class='docblock-short'><p>Includes a utf8-encoded file as a string.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.line.html" title='core::line macro'>line</a></td><td class='docblock-short'><p>Expands to the line number on which it was invoked.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.module_path.html" title='core::module_path macro'>module_path</a></td><td class='docblock-short'><p>Expands to a string that represents the current module path.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.option_env.html" title='core::option_env macro'>option_env</a></td><td class='docblock-short'><p>Optionally inspects an environment variable at compile time.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.panic.html" title='core::panic macro'>panic</a></td><td class='docblock-short'><p>Panics the current thread.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.stringify.html" title='core::stringify macro'>stringify</a></td><td class='docblock-short'><p>Stringifies its arguments.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.try.html" title='core::try macro'>try</a></td><td class='docblock-short'><p>Unwraps a result or propagates its error.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.unimplemented.html" title='core::unimplemented macro'>unimplemented</a></td><td class='docblock-short'><p>Indicates unfinished code.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.unreachable.html" title='core::unreachable macro'>unreachable</a></td><td class='docblock-short'><p>Indicates unreachable code.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.write.html" title='core::write macro'>write</a></td><td class='docblock-short'><p>Writes formatted data into a buffer.</p>
</td></tr><tr class='module-item'><td><a class="macro" href="macro.writeln.html" title='core::writeln macro'>writeln</a></td><td class='docblock-short'><p>Write formatted data into a buffer, with a newline appended.</p>
</td></tr><tr class='unstable module-item'><td><a class="macro" href="macro.concat_idents.html" title='core::concat_idents macro'>concat_idents</a></td><td class='docblock-short'><span class="stab unstable">Experimental</span><p>Concatenates identifiers into one identifier.</p>
</td></tr><tr class='unstable module-item'><td><a class="macro" href="macro.todo.html" title='core::todo macro'>todo</a></td><td class='docblock-short'><span class="stab unstable">Experimental</span><p>Indicates unfinished code.</p>
</td></tr><tr class='unstable module-item'><td><a class="macro" href="macro.uninitialized_array.html" title='core::uninitialized_array macro'>uninitialized_array</a></td><td class='docblock-short'><span class="stab unstable">Experimental</span><p>Creates an array of <a href="mem/union.MaybeUninit.html"><code>MaybeUninit</code></a>.</p>
</td></tr></table></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>&#9166;</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 = "core";</script><script src="../aliases.js"></script><script src="../main1.35.0.js"></script><script defer src="../search-index.js"></script></body></html>