2016-06-04 12:13:48 -05:00
<!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 `Version` enum in crate `qrcode`." >
< meta name = "keywords" content = "rust, rustlang, rust-lang, Version" >
< title > qrcode::types::Version - Rust< / title >
< link rel = "stylesheet" type = "text/css" href = "../../rustdoc.css" >
< link rel = "stylesheet" type = "text/css" href = "../../main.css" >
< / head >
< body class = "rustdoc" >
<!-- [if lte IE 8]>
< div class = "warning" >
This old browser is unsupported and will most likely display funky
things.
< / div >
<![endif]-->
< nav class = "sidebar" >
< p class = 'location' > < a href = '../index.html' > qrcode< / a > ::< wbr > < a href = 'index.html' > types< / a > < / p > < script > window . sidebarCurrent = { name : 'Version' , ty : 'enum' , relpath : '' } ; < / script > < script defer src = "sidebar-items.js" > < / script >
< / nav >
< nav class = "sub" >
< form class = "search-form js-only" >
< div class = "search-container" >
< input class = "search-input" name = "search"
autocomplete="off"
placeholder="Click or press ‘ S’ to search, ‘ ?’ for more options…"
type="search">
< / div >
< / form >
< / nav >
< section id = 'main' class = "content enum" >
< h1 class = 'fqn' > < span class = 'in-band' > Enum < a href = '../index.html' > qrcode< / a > ::< wbr > < a href = 'index.html' > types< / a > ::< wbr > < a class = 'enum' href = '' > Version< / a > < / span > < 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 id = 'src-89' class = 'srclink' href = '../../src/qrcode/src/types.rs.html#77-83' title = 'goto source code' > [src]< / a > < / span > < / h1 >
< pre class = 'rust enum' > pub enum Version {
Normal(< a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.i16.html' > i16< / a > ),
Micro(< a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.i16.html' > i16< / a > ),
}< / pre > < div class = 'docblock' > < p > In QR code terminology, < code > Version< / code > means the size of the generated image.
Larger version means the size of code is larger, and therefore can carry
more information.< / p >
< p > The smallest version is < code > Version::Normal(1)< / code > of size 21× 21, and the largest
is < code > Version::Normal(40)< / code > of size 177× 177.< / p >
< / div > < h2 class = 'variants' > Variants< / h2 >
2016-06-07 11:51:19 -05:00
< span id = 'variant.Normal' class = 'variant' > < code > Normal(< a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.i16.html' > i16< / a > )< / code > < / span > < div class = 'docblock' > < p > A normal QR code version. The parameter should be between 1 and 40.< / p >
< / div > < span id = 'variant.Micro' class = 'variant' > < code > Micro(< a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.i16.html' > i16< / a > )< / code > < / span > < div class = 'docblock' > < p > A Micro QR code version. The parameter should be between 1 and 4.< / p >
< / div > < h2 id = 'methods' > Methods< / h2 > < h3 class = 'impl' > < span class = 'in-band' > < code > impl < a class = 'enum' href = '../../qrcode/types/enum.Version.html' title = 'qrcode::types::Version' > Version< / a > < / code > < / span > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a id = 'src-132' class = 'srclink' href = '../../src/qrcode/src/types.rs.html#85-137' title = 'goto source code' > [src]< / a > < / span > < / h3 >
2016-06-04 12:13:48 -05:00
< div class = 'impl-items' > < h4 id = 'method.width' class = 'method' > < code > fn < a href = '#method.width' class = 'fnname' > width< / a > (& self) -> < a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.i16.html' > i16< / a > < / code > < / h4 >
< div class = 'docblock' > < p > Get the number of " modules" on each size of the QR code, i.e. the width
and height of the code.< / p >
< / div > < h4 id = 'method.fetch' class = 'method' > < code > fn < a href = '#method.fetch' class = 'fnname' > fetch< / a > < T> (& self, ec_level: < a class = 'enum' href = '../../qrcode/types/enum.EcLevel.html' title = 'qrcode::types::EcLevel' > EcLevel< / a > , table: < a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.slice.html' > & [< / a > < a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.array.html' > [< / a > T< a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.array.html' > ; 4]< / a > < a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.slice.html' > ]< / a > ) -> < a class = 'type' href = '../../qrcode/types/type.QrResult.html' title = 'qrcode::types::QrResult' > QrResult< / a > < T> < span class = 'where' > where T: < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html' title = 'core::cmp::PartialEq' > PartialEq< / a > + < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/default/trait.Default.html' title = 'core::default::Default' > Default< / a > + < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html' title = 'core::marker::Copy' > Copy< / a > < / span > < / code > < / h4 >
< div class = 'docblock' > < p > Obtains an object from a hard-coded table.< / p >
< p > The table must be a 44× 4 array. The outer array represents the content
for each version. The first 40 entry corresponds to QR code versions 1
to 40, and the last 4 corresponds to Micro QR code version 1 to 4. The
inner array represents the content in each error correction level, in
the order [L, M, Q, H].< / p >
< p > If the entry compares equal to the default value of T, this method
returns < code > Err(QrError::InvalidVersion)< / code > .< / p >
< / div > < h4 id = 'method.mode_bits_count' class = 'method' > < code > fn < a href = '#method.mode_bits_count' class = 'fnname' > mode_bits_count< / a > (& self) -> < a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.usize.html' > usize< / a > < / code > < / h4 >
< div class = 'docblock' > < p > The number of bits needed to encode the mode indicator.< / p >
< / div > < h4 id = 'method.is_micro' class = 'method' > < code > fn < a href = '#method.is_micro' class = 'fnname' > is_micro< / a > (& self) -> < a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.bool.html' > bool< / a > < / code > < / h4 >
< div class = 'docblock' > < p > Checks whether is version refers to a Micro QR code.< / p >
< / div > < / div > < h2 id = 'implementations' > Trait Implementations< / h2 > < h3 id = 'derived_implementations' > Derived Implementations < / h3 > < h3 class = 'impl' > < span class = 'in-band' > < code > impl < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title = 'core::clone::Clone' > Clone< / a > for < a class = 'enum' href = '../../qrcode/types/enum.Version.html' title = 'qrcode::types::Version' > Version< / a > < / code > < / span > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a id = 'src-94' class = 'srclink' href = '../../src/qrcode/src/types.rs.html#76' title = 'goto source code' > [src]< / a > < / span > < / h3 >
< div class = 'impl-items' > < h4 id = 'method.clone' class = 'method' > < code > 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 = '../../qrcode/types/enum.Version.html' title = 'qrcode::types::Version' > Version< / a > < / code > < / h4 >
< div class = 'docblock' > < 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' > < code > 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: & Self)< / code > < div class = 'since' title = 'Stable since Rust version 1.0.0' > 1.0.0< / div > < / h4 >
< div class = 'docblock' > < 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 class = 'impl' > < span class = 'in-band' > < code > impl < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html' title = 'core::marker::Copy' > Copy< / a > for < a class = 'enum' href = '../../qrcode/types/enum.Version.html' title = 'qrcode::types::Version' > Version< / a > < / code > < / span > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a id = 'src-99' class = 'srclink' href = '../../src/qrcode/src/types.rs.html#76' title = 'goto source code' > [src]< / a > < / span > < / h3 >
< div class = 'impl-items' > < / div > < h3 class = 'impl' > < span class = 'in-band' > < code > impl < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html' title = 'core::cmp::Eq' > Eq< / a > for < a class = 'enum' href = '../../qrcode/types/enum.Version.html' title = 'qrcode::types::Version' > Version< / a > < / code > < / span > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a id = 'src-100' class = 'srclink' href = '../../src/qrcode/src/types.rs.html#76' title = 'goto source code' > [src]< / a > < / span > < / h3 >
< div class = 'impl-items' > < / div > < h3 class = 'impl' > < span class = 'in-band' > < code > impl < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html' title = 'core::cmp::PartialEq' > PartialEq< / a > for < a class = 'enum' href = '../../qrcode/types/enum.Version.html' title = 'qrcode::types::Version' > Version< / a > < / code > < / span > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a id = 'src-105' class = 'srclink' href = '../../src/qrcode/src/types.rs.html#76' title = 'goto source code' > [src]< / a > < / span > < / h3 >
< div class = 'impl-items' > < h4 id = 'method.eq' class = 'method' > < code > fn < a href = 'https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class = 'fnname' > eq< / a > (& self, __arg_0: & < a class = 'enum' href = '../../qrcode/types/enum.Version.html' title = 'qrcode::types::Version' > Version< / a > ) -> < a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.bool.html' > bool< / a > < / code > < / h4 >
< div class = 'docblock' > < 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' > < code > fn < a href = 'https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class = 'fnname' > ne< / a > (& self, __arg_0: & < a class = 'enum' href = '../../qrcode/types/enum.Version.html' title = 'qrcode::types::Version' > Version< / a > ) -> < a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.bool.html' > bool< / a > < / code > < / h4 >
< div class = 'docblock' > < p > This method tests for < code > !=< / code > .< / p >
< / div > < / div > < h3 class = 'impl' > < span class = 'in-band' > < code > impl < a class = 'trait' href = 'https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html' title = 'core::fmt::Debug' > Debug< / a > for < a class = 'enum' href = '../../qrcode/types/enum.Version.html' title = 'qrcode::types::Version' > Version< / a > < / code > < / span > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a id = 'src-124' class = 'srclink' href = '../../src/qrcode/src/types.rs.html#76' title = 'goto source code' > [src]< / a > < / span > < / h3 >
< div class = 'impl-items' > < h4 id = 'method.fmt' class = 'method' > < code > fn < a href = 'https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class = 'fnname' > fmt< / a > (& self, __arg_0: & mut < a class = 'struct' href = 'https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html' title = 'core::fmt::Formatter' > Formatter< / a > ) -> < a class = 'type' href = 'https://doc.rust-lang.org/nightly/core/fmt/type.Result.html' title = 'core::fmt::Result' > Result< / a > < / code > < / h4 >
< div class = 'docblock' > < p > Formats the value using the given formatter.< / p >
< / 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 > ?< / dt >
< dd > Show this help dialog< / dd >
< dt > S< / dt >
< dd > Focus the search field< / dd >
< dt > ⇤ < / dt >
< dd > Move up in search results< / dd >
< dt > ⇥ < / dt >
< dd > Move down in search results< / dd >
< dt > ⏎ < / dt >
< dd > Go to active search result< / dd >
< dt > +< / dt >
< dd > Collapse/expand 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 >
< / div >
< / div >
< / aside >
< script >
window.rootPath = "../../";
window.currentCrate = "qrcode";
window.playgroundUrl = "";
< / script >
< script src = "../../jquery.js" > < / script >
< script src = "../../main.js" > < / script >
< script defer src = "../../search-index.js" > < / script >
< / body >
< / html >