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 `Module` enum in crate `qrcode`." >
< meta name = "keywords" content = "rust, rustlang, rust-lang, Module" >
< title > qrcode::canvas::Module - 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' > canvas< / a > < / p > < script > window . sidebarCurrent = { name : 'Module' , 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 ‘ ’ ‘ ’
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' > canvas< / a > ::< wbr > < a class = 'enum' href = '' > Module< / 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-661' class = 'srclink' href = '../../src/qrcode/src/canvas.rs.html#30-49' title = 'goto source code' > [src]< / a > < / span > < / h1 >
< pre class = 'rust enum' > pub enum Module {
Empty,
Light,
Dark,
LightUnmasked,
DarkUnmasked,
}< / pre > < div class = 'docblock' > < p > The color of a module (pixel) in the QR code.< / p >
< / div > < h2 class = 'variants' > Variants< / h2 >
2016-06-07 11:51:19 -05:00
< span id = 'variant.Empty' class = 'variant' > < code > Empty< / code > < / span > < div class = 'docblock' > < p > The module is empty.< / p >
< / div > < span id = 'variant.Light' class = 'variant' > < code > Light< / code > < / span > < div class = 'docblock' > < p > The module is light (white), and cannot be masked. This mainly refers to
2016-06-04 12:13:48 -05:00
modules of functional patterns.< / p >
2016-06-07 11:51:19 -05:00
< / div > < span id = 'variant.Dark' class = 'variant' > < code > Dark< / code > < / span > < div class = 'docblock' > < p > The module is dark (black), and cannot be masked. This mainly refers to
2016-06-04 12:13:48 -05:00
modules of functional patterns.< / p >
2016-06-07 11:51:19 -05:00
< / div > < span id = 'variant.LightUnmasked' class = 'variant' > < code > LightUnmasked< / code > < / span > < div class = 'docblock' > < p > The module is light (white), but not yet masked. This mainly refers to
2016-06-04 12:13:48 -05:00
modules of data and error correction bits before masking.< / p >
2016-06-07 11:51:19 -05:00
< / div > < span id = 'variant.DarkUnmasked' class = 'variant' > < code > DarkUnmasked< / code > < / span > < div class = 'docblock' > < p > The module is dark (black), but not yet masked. This mainly refers to
2016-06-04 12:13:48 -05:00
modules of data and error correction bits before masking.< / p >
2016-06-07 11:51:19 -05:00
< / div > < h2 id = 'methods' > Methods< / h2 > < h3 class = 'impl' > < span class = 'in-band' > < code > impl < a class = 'enum' href = '../../qrcode/canvas/enum.Module.html' title = 'qrcode::canvas::Module' > Module< / a > < / code > < / span > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a id = 'src-689' class = 'srclink' href = '../../src/qrcode/src/canvas.rs.html#51-79' title = 'goto source code' > [src]< / a > < / span > < / h3 >
2016-06-04 12:13:48 -05:00
< div class = 'impl-items' > < h4 id = 'method.is_dark' class = 'method' > < code > fn < a href = '#method.is_dark' class = 'fnname' > is_dark< / 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 a module is dark.< / p >
< / div > < h4 id = 'method.mask' class = 'method' > < code > fn < a href = '#method.mask' class = 'fnname' > mask< / a > (& self, should_invert: < a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.bool.html' > bool< / a > ) -> < a class = 'enum' href = '../../qrcode/canvas/enum.Module.html' title = 'qrcode::canvas::Module' > Module< / a > < / code > < / h4 >
< div class = 'docblock' > < p > Apply a mask to the unmasked modules.< / p >
< pre class = 'rust rust-example-rendered' >
< span class = 'kw' > use< / span > < span class = 'ident' > qrcode< / span > ::< span class = 'ident' > canvas< / span > ::< span class = 'ident' > Module< / span > ;
< span class = 'macro' > assert_eq< / span > < span class = 'macro' > !< / span > (< span class = 'ident' > Module< / span > ::< span class = 'ident' > LightUnmasked< / span > .< span class = 'ident' > mask< / span > (< span class = 'boolvalue' > true< / span > ), < span class = 'ident' > Module< / span > ::< span class = 'ident' > Dark< / span > );
< span class = 'macro' > assert_eq< / span > < span class = 'macro' > !< / span > (< span class = 'ident' > Module< / span > ::< span class = 'ident' > DarkUnmasked< / span > .< span class = 'ident' > mask< / span > (< span class = 'boolvalue' > true< / span > ), < span class = 'ident' > Module< / span > ::< span class = 'ident' > Light< / span > );
< span class = 'macro' > assert_eq< / span > < span class = 'macro' > !< / span > (< span class = 'ident' > Module< / span > ::< span class = 'ident' > LightUnmasked< / span > .< span class = 'ident' > mask< / span > (< span class = 'boolvalue' > false< / span > ), < span class = 'ident' > Module< / span > ::< span class = 'ident' > Light< / span > );
< span class = 'macro' > assert_eq< / span > < span class = 'macro' > !< / span > (< span class = 'ident' > Module< / span > ::< span class = 'ident' > Dark< / span > .< span class = 'ident' > mask< / span > (< span class = 'boolvalue' > true< / span > ), < span class = 'ident' > Module< / span > ::< span class = 'ident' > Dark< / span > );
< span class = 'macro' > assert_eq< / span > < span class = 'macro' > !< / span > (< span class = 'ident' > Module< / span > ::< span class = 'ident' > Dark< / span > .< span class = 'ident' > mask< / span > (< span class = 'boolvalue' > false< / span > ), < span class = 'ident' > Module< / span > ::< span class = 'ident' > Dark< / span > );< / pre >
< / 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/fmt/trait.Debug.html' title = 'core::fmt::Debug' > Debug< / a > for < a class = 'enum' href = '../../qrcode/canvas/enum.Module.html' title = 'qrcode::canvas::Module' > Module< / a > < / code > < / span > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a id = 'src-667' class = 'srclink' href = '../../src/qrcode/src/canvas.rs.html#29' 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 > < 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/canvas/enum.Module.html' title = 'qrcode::canvas::Module' > Module< / a > < / code > < / span > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a id = 'src-676' class = 'srclink' href = '../../src/qrcode/src/canvas.rs.html#29' 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/clone/trait.Clone.html' title = 'core::clone::Clone' > Clone< / a > for < a class = 'enum' href = '../../qrcode/canvas/enum.Module.html' title = 'qrcode::canvas::Module' > Module< / a > < / code > < / span > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a id = 'src-677' class = 'srclink' href = '../../src/qrcode/src/canvas.rs.html#29' 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/canvas/enum.Module.html' title = 'qrcode::canvas::Module' > Module< / 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/cmp/trait.Eq.html' title = 'core::cmp::Eq' > Eq< / a > for < a class = 'enum' href = '../../qrcode/canvas/enum.Module.html' title = 'qrcode::canvas::Module' > Module< / a > < / code > < / span > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a id = 'src-680' class = 'srclink' href = '../../src/qrcode/src/canvas.rs.html#29' 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/canvas/enum.Module.html' title = 'qrcode::canvas::Module' > Module< / a > < / code > < / span > < span class = 'out-of-band' > < div class = 'ghost' > < / div > < a id = 'src-683' class = 'srclink' href = '../../src/qrcode/src/canvas.rs.html#29' 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/canvas/enum.Module.html' title = 'qrcode::canvas::Module' > Module< / 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, other: & Rhs) -> < a class = 'primitive' href = 'https://doc.rust-lang.org/nightly/std/primitive.bool.html' > bool< / a > < / code > < div class = 'since' title = 'Stable since Rust version 1.0.0' > 1.0.0< / div > < / h4 >
< div class = 'docblock' > < p > This method tests for < code > !=< / code > .< / 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 >
