Enum Mode

pub enum Mode {
    Numeric,
    Alphanumeric,
    Byte,
    Kanji,
}

The mode indicator, which specifies the character set of the encoded data.

Variants

Numeric

The data contains only characters 0 to 9.

Alphanumeric

The data contains only uppercase letters (A–Z), numbers (0–9) and a few punctuations marks (space, $, %, *, +, -, ., /, :).

Byte

The data contains arbitrary binary data.

Kanji

The data contains Shift-JIS-encoded double-byte text.

Implementations

impl Mode

pub fn length_bits_count(self, version: Version) -> usize

Computes the number of bits needed to encode the data length.

use qrcode::types::{Version, Mode};

assert_eq!(Mode::Numeric.length_bits_count(Version::Normal(1)), 10);

This method will return Err(QrError::UnsupportedCharacterSet) if the mode is not supported in the given version.

pub fn data_bits_count(self, raw_data_len: usize) -> usize

Computes the number of bits needed to some data of a given raw length.

use qrcode::types::Mode;

assert_eq!(Mode::Numeric.data_bits_count(7), 24);

Note that in Kanji mode, the raw_data_len is the number of Kanjis, i.e. half the total size of bytes.

pub fn max(self, other: Self) -> Self

Find the lowest common mode which both modes are compatible with.

use qrcode::types::Mode;

let a = Mode::Numeric;
let b = Mode::Kanji;
let c = a.max(b);
assert!(a <= c);
assert!(b <= c);

Trait Implementations

impl Clone for Mode

fn clone(&self) -> Mode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Mode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Mode

fn eq(&self, other: &Mode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Mode

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

Defines a partial ordering between modes. If a <= b, then b contains a superset of all characters supported by a.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Mode

impl Eq for Mode

impl StructuralPartialEq for Mode