|
|
<!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 `Font` struct in crate `rusttype`."><meta name="keywords" content="rust, rustlang, rust-lang, Font"><title>rusttype::Font - 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 struct"><!--[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='../rusttype/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Struct Font</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.font_name_strings">font_name_strings</a><a href="#method.from_bytes">from_bytes</a><a href="#method.glyph">glyph</a><a href="#method.glyph_count">glyph_count</a><a href="#method.glyphs_for">glyphs_for</a><a href="#method.layout">layout</a><a href="#method.pair_kerning">pair_kerning</a><a href="#method.units_per_em">units_per_em</a><a href="#method.v_metrics">v_metrics</a><a href="#method.v_metrics_unscaled">v_metrics_unscaled</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</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'>rusttype</a></p><script>window.sidebarCurrent = {name: 'Font', ty: 'struct', 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" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/rusttype/lib.rs.html#145-147' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='index.html'>rusttype</a>::<wbr><a class="struct" href=''>Font</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'>pub struct Font<'a> { /* fields omitted */ }</pre></div><div class='docblock'><p>A single font. This may or may not own the font data.</p>
|
|
|
<h1 id="lifetime" class="section-header"><a href="#lifetime">Lifetime</a></h1>
|
|
|
<p>The lifetime reflects the font data lifetime. <code>Font<'static></code> covers most
|
|
|
cases ie both dynamically loaded owned data and for referenced compile time
|
|
|
font data.</p>
|
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">let</span> <span class="ident">font_data</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>] <span class="op">=</span> <span class="macro">include_bytes</span><span class="macro">!</span>(<span class="string">"../fonts/dejavu/DejaVuSansMono.ttf"</span>);
|
|
|
<span class="kw">let</span> <span class="ident">font</span>: <span class="ident">Font</span><span class="op"><</span><span class="lifetime">'static</span><span class="op">></span> <span class="op">=</span> <span class="ident">Font</span>::<span class="ident">from_bytes</span>(<span class="ident">font_data</span>)<span class="question-mark">?</span>;
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">owned_font_data</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">u8</span><span class="op">></span> <span class="op">=</span> <span class="ident">font_data</span>.<span class="ident">to_vec</span>();
|
|
|
<span class="kw">let</span> <span class="ident">from_owned_font</span>: <span class="ident">Font</span><span class="op"><</span><span class="lifetime">'static</span><span class="op">></span> <span class="op">=</span> <span class="ident">Font</span>::<span class="ident">from_bytes</span>(<span class="ident">owned_font_data</span>)<span class="question-mark">?</span>;</pre></div>
|
|
|
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl<'a> <a class="struct" href="../rusttype/struct.Font.html" title="struct rusttype::Font">Font</a><'a></code><a href='#impl' class='anchor'></a><a class='srclink' href='../src/rusttype/lib.rs.html#502-635' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from_bytes' class="method"><code id='from_bytes.v'>pub fn <a href='#method.from_bytes' class='fnname'>from_bytes</a><B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../rusttype/enum.SharedBytes.html" title="enum rusttype::SharedBytes">SharedBytes</a><'a>>>(bytes: B) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../rusttype/struct.Font.html" title="struct rusttype::Font">Font</a><'a>, <a class="enum" href="../rusttype/enum.Error.html" title="enum rusttype::Error">Error</a>></code><a class='srclink' href='../src/rusttype/lib.rs.html#505-507' title='goto source code'>[src]</a></h4><div class='docblock'><p>Constructs a font from an array of bytes, this is a shortcut for
|
|
|
<code>FontCollection::from_bytes</code> for collections comprised of a single font.</p>
|
|
|
</div><h4 id='method.v_metrics' class="method"><code id='v_metrics.v'>pub fn <a href='#method.v_metrics' class='fnname'>v_metrics</a>(&self, scale: <a class="struct" href="../rusttype/struct.Scale.html" title="struct rusttype::Scale">Scale</a>) -> <a class="struct" href="../rusttype/struct.VMetrics.html" title="struct rusttype::VMetrics">VMetrics</a></code><a class='srclink' href='../src/rusttype/lib.rs.html#511-515' title='goto source code'>[src]</a></h4><div class='docblock'><p>The "vertical metrics" for this font at a given scale. These metrics are
|
|
|
shared by all of the glyphs in the font. See <code>VMetrics</code> for more detail.</p>
|
|
|
</div><h4 id='method.v_metrics_unscaled' class="method"><code id='v_metrics_unscaled.v'>pub fn <a href='#method.v_metrics_unscaled' class='fnname'>v_metrics_unscaled</a>(&self) -> <a class="struct" href="../rusttype/struct.VMetrics.html" title="struct rusttype::VMetrics">VMetrics</a></code><a class='srclink' href='../src/rusttype/lib.rs.html#519-521' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get the unscaled VMetrics for this font, shared by all glyphs.
|
|
|
See <code>VMetrics</code> for more detail.</p>
|
|
|
</div><h4 id='method.units_per_em' class="method"><code id='units_per_em.v'>pub fn <a href='#method.units_per_em' class='fnname'>units_per_em</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code><a class='srclink' href='../src/rusttype/lib.rs.html#524-526' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns the units per EM square of this font</p>
|
|
|
</div><h4 id='method.glyph_count' class="method"><code id='glyph_count.v'>pub fn <a href='#method.glyph_count' class='fnname'>glyph_count</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/rusttype/lib.rs.html#530-532' title='goto source code'>[src]</a></h4><div class='docblock'><p>The number of glyphs present in this font. Glyph identifiers for this
|
|
|
font will always be in the range <code>0..self.glyph_count()</code></p>
|
|
|
</div><h4 id='method.glyph' class="method"><code id='glyph.v'>pub fn <a href='#method.glyph' class='fnname'>glyph</a><C: <a class="trait" href="../rusttype/trait.IntoGlyphId.html" title="trait rusttype::IntoGlyphId">IntoGlyphId</a>>(&self, id: C) -> <a class="struct" href="../rusttype/struct.Glyph.html" title="struct rusttype::Glyph">Glyph</a><'a></code><a class='srclink' href='../src/rusttype/lib.rs.html#544-549' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns the corresponding glyph for a Unicode code point or a glyph id
|
|
|
for this font.</p>
|
|
|
<p>If <code>id</code> is a <code>GlyphId</code>, it must be valid for this font; otherwise, this
|
|
|
function panics. <code>GlyphId</code>s should always be produced by looking up some
|
|
|
other sort of designator (like a Unicode code point) in a font, and
|
|
|
should only be used to index the font they were produced for.</p>
|
|
|
<p>Note that code points without corresponding glyphs in this font map to
|
|
|
the ".notdef" glyph, glyph 0.</p>
|
|
|
</div><h4 id='method.glyphs_for' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../rusttype/struct.GlyphIter.html" title="struct rusttype::GlyphIter">GlyphIter</a><'a, 'b, I></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../rusttype/struct.GlyphIter.html" title="struct rusttype::GlyphIter">GlyphIter</a><'a, 'b, I></h3><code class="content"><span class="where fmt-newline">impl<'a, 'b, I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <a class="struct" href="../rusttype/struct.GlyphIter.html" title="struct rusttype::GlyphIter">GlyphIter</a><'a, 'b, I> <span class="where fmt-newline">where<br> I::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::traits::iterator::Iterator::Item">Item</a>: <a class="trait" href="../rusttype/trait.IntoGlyphId.html" title="trait rusttype::IntoGlyphId">IntoGlyphId</a>, </span></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="struct" href="../rusttype/struct.Glyph.html" title="struct rusttype::Glyph">Glyph</a><'a>;</span></code></div></div><code id='glyphs_for.v'>pub fn <a href='#method.glyphs_for' class='fnname'>glyphs_for</a><I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a>>(&self, itr: I) -> <a class="struct" href="../rusttype/struct.GlyphIter.html" title="struct rusttype::GlyphIter">GlyphIter</a><'a, '_, I> <span class="where fmt-newline">where<br> I::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::traits::iterator::Iterator::Item">Item</a>: <a class="trait" href="../rusttype/trait.IntoGlyphId.html" title="trait rusttype::IntoGlyphId">IntoGlyphId</a>, </span></code><a class='srclink' href='../src/rusttype/lib.rs.html#556-561' title='goto source code'>[src]</a></h4><div class='docblock'><p>A convenience function.</p>
|
|
|
<p>Returns an iterator that produces the glyphs corresponding to the code
|
|
|
points or glyph ids produced by the given iterator <code>itr</code>.</p>
|
|
|
<p>This is equivalent in behaviour to <code>itr.map(|c| font.glyph(c))</code>.</p>
|
|
|
</div><h4 id='method.font_name_strings' class="method"><code id='font_name_strings.v'>pub fn <a href='#method.font_name_strings' class='fnname'>font_name_strings</a>(&self) -> <a class="struct" href="../stb_truetype/struct.FontNameIter.html" title="struct stb_truetype::FontNameIter">FontNameIter</a><<a class="enum" href="../rusttype/enum.SharedBytes.html" title="enum rusttype::SharedBytes">SharedBytes</a><'a>></code><a class='srclink' href='../src/rusttype/lib.rs.html#563-565' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns an iterator over the names for this font.</p>
|
|
|
</div><h4 id='method.layout' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../rusttype/struct.LayoutIter.html" title="struct rusttype::LayoutIter">LayoutIter</a><'a, 'b></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../rusttype/struct.LayoutIter.html" title="struct rusttype::LayoutIter">LayoutIter</a><'a, 'b></h3><code class="content"><span class="where fmt-newline">impl<'a, 'b> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <a class="struct" href="../rusttype/struct.LayoutIter.html" title="struct rusttype::LayoutIter">LayoutIter</a><'a, 'b></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="struct" href="../rusttype/struct.PositionedGlyph.html" title="struct rusttype::PositionedGlyph">PositionedGlyph</a><'a>;</span></code></div></div><code id='layout.v'>pub fn <a href='#method.layout' class='fnname'>layout</a><'b>(<br> &'b self, <br> s: &'b <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>, <br> scale: <a class="struct" href="../rusttype/struct.Scale.html" title="struct rusttype::Scale">Scale</a>, <br> start: <a class="struct" href="../rusttype/struct.Point.html" title="struct rusttype::Point">Point</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>><br>) -> <a class="struct" href="../rusttype/struct.LayoutIter.html" title="struct rusttype::LayoutIter">LayoutIter</a><'a, 'b></code><a class='srclink' href='../src/rusttype/lib.rs.html#612-621' title='goto source code'>[src]</a></h4><div class='docblock'><p>A convenience function for laying out glyphs for a string horizontally.
|
|
|
It does not take control characters like line breaks into account, as
|
|
|
treatment of these is likely to depend on the application.</p>
|
|
|
<p>Note that this function does not perform Unicode normalisation.
|
|
|
Composite characters (such as ö constructed from two code points, ¨ and
|
|
|
o), will not be normalised to single code points. So if a font does not
|
|
|
contain a glyph for each separate code point, but does contain one for
|
|
|
the normalised single code point (which is common), the desired glyph
|
|
|
will not be produced, despite being present in the font. Deal with this
|
|
|
by performing Unicode normalisation on the input string before passing
|
|
|
it to <code>layout</code>. The crate
|
|
|
<a href="http://crates.io/crates/unicode-normalization">unicode-normalization</a>
|
|
|
is perfect for this purpose.</p>
|
|
|
<p>Calling this function is equivalent to a longer sequence of operations
|
|
|
involving <code>glyphs_for</code>, e.g.</p>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="ident">font</span>.<span class="ident">layout</span>(<span class="string">"Hello World!"</span>, <span class="ident">scale</span>, <span class="ident">start</span>)</pre></div>
|
|
|
<p>produces an iterator with behaviour equivalent to the following:</p>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="ident">font</span>.<span class="ident">glyphs_for</span>(<span class="string">"Hello World!"</span>.<span class="ident">chars</span>())
|
|
|
.<span class="ident">scan</span>((<span class="prelude-val">None</span>, <span class="number">0.0</span>), <span class="op">|</span><span class="kw-2">&</span><span class="kw-2">mut</span> (<span class="kw-2">mut</span> <span class="ident">last</span>, <span class="kw-2">mut</span> <span class="ident">x</span>), <span class="ident">g</span><span class="op">|</span> {
|
|
|
<span class="kw">let</span> <span class="ident">g</span> <span class="op">=</span> <span class="ident">g</span>.<span class="ident">scaled</span>(<span class="ident">scale</span>);
|
|
|
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">last</span>) <span class="op">=</span> <span class="ident">last</span> {
|
|
|
<span class="ident">x</span> <span class="op">+</span><span class="op">=</span> <span class="ident">font</span>.<span class="ident">pair_kerning</span>(<span class="ident">scale</span>, <span class="ident">last</span>, <span class="ident">g</span>.<span class="ident">id</span>());
|
|
|
}
|
|
|
<span class="kw">let</span> <span class="ident">w</span> <span class="op">=</span> <span class="ident">g</span>.<span class="ident">h_metrics</span>().<span class="ident">advance_width</span>;
|
|
|
<span class="kw">let</span> <span class="ident">next</span> <span class="op">=</span> <span class="ident">g</span>.<span class="ident">positioned</span>(<span class="ident">start</span> <span class="op">+</span> <span class="ident">vector</span>(<span class="ident">x</span>, <span class="number">0.0</span>));
|
|
|
<span class="ident">last</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">next</span>.<span class="ident">id</span>());
|
|
|
<span class="ident">x</span> <span class="op">+</span><span class="op">=</span> <span class="ident">w</span>;
|
|
|
<span class="prelude-val">Some</span>(<span class="ident">next</span>)
|
|
|
})</pre></div>
|
|
|
</div><h4 id='method.pair_kerning' class="method"><code id='pair_kerning.v'>pub fn <a href='#method.pair_kerning' class='fnname'>pair_kerning</a><A, B>(&self, scale: <a class="struct" href="../rusttype/struct.Scale.html" title="struct rusttype::Scale">Scale</a>, first: A, second: B) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a> <span class="where fmt-newline">where<br> A: <a class="trait" href="../rusttype/trait.IntoGlyphId.html" title="trait rusttype::IntoGlyphId">IntoGlyphId</a>,<br> B: <a class="trait" href="../rusttype/trait.IntoGlyphId.html" title="trait rusttype::IntoGlyphId">IntoGlyphId</a>, </span></code><a class='srclink' href='../src/rusttype/lib.rs.html#624-634' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns additional kerning to apply as well as that given by HMetrics
|
|
|
for a particular pair of glyphs.</p>
|
|
|
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Clone' class='impl'><code class='in-band'>impl<'a> <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="struct" href="../rusttype/struct.Font.html" title="struct rusttype::Font">Font</a><'a></code><a href='#impl-Clone' class='anchor'></a><a class='srclink' href='../src/rusttype/lib.rs.html#144' 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="struct" href="../rusttype/struct.Font.html" title="struct rusttype::Font">Font</a><'a></code><a class='srclink' href='../src/rusttype/lib.rs.html#144' 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-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="struct" href="../rusttype/struct.Font.html" title="struct rusttype::Font">Font</a><'_></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../src/rusttype/lib.rs.html#149-153' 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/rusttype/lib.rs.html#150-152' 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-Send' class='impl'><code class='in-band'>impl<'a> <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="struct" href="../rusttype/struct.Font.html" title="struct rusttype::Font">Font</a><'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> <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="struct" href="../rusttype/struct.Font.html" title="struct rusttype::Font">Font</a><'a></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl<'a> <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="struct" href="../rusttype/struct.Font.html" title="struct rusttype::Font">Font</a><'a></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl<'a> <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="struct" href="../rusttype/struct.Font.html" title="struct rusttype::Font">Font</a><'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> <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="struct" href="../rusttype/struct.Font.html" title="struct rusttype::Font">Font</a><'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-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-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#544-549' 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#546-548' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</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#553-555' 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#554' 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#572-578' 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#575-577' 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#560-567' 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#564-566' 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 = "rusttype";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
