Struct datamatrix::SymbolList

pub struct SymbolList { /* private fields */ }

Set of symbol sizes the encoder is allowed to use.

Specifies a list of symbol sizes the encoder will pick from. The smallest symbol which can hold the data is chosen.

By default all standard sizes defined in ISO 16022 are used. The selection can be restricted to square or rectangular symbols, symbols within a size range, or by giving an explicit list.

Examples

To get all rectangles with maximum height 20, including the rectangle extensions you can write

let code = DataMatrix::encode(
    b"Hello, World!",
    SymbolList::with_extended_rectangles()
        .enforce_rectangular()
        .enforce_height_in(..=20),
);

Because SymbolSize and [SymbolSize; N] implement Into<SymbolList> you can write

// a) use one specific symbol size
let code = DataMatrix::encode(b"content to encode", SymbolSize::Square22);

// b) custom list of allowed symbol sizes
let code = DataMatrix::encode(
    b"content to encode",
    [SymbolSize::Square22, SymbolSize::Square26],
);

Implementations

impl SymbolList

pub fn with_extended_rectangles() -> Self

Get standard symbol sizes extended by all DMRE rectangles.

In ISO 21471 additional rectangular sizes are defined. Be aware that your decoder might not recognize these.

DMRE stands for Data Matrix Rectangular Extensions.

pub fn enforce_square(self) -> Self

Remove all non-square symbols from the current selection.

pub fn enforce_rectangular(self) -> Self

Remove all square symbols from the current selection.

pub fn enforce_width_in<R: RangeBounds<usize>>(self, bounds: R) -> Self

Only keep symbols with width in the given range.

pub fn enforce_height_in<R: RangeBounds<usize>>(self, bounds: R) -> Self

Only keep symbols with height in the given range.

pub fn with_whitelist<I>(whitelist: I) -> Self where
    I: IntoIterator<Item = SymbolSize>, 

Create a symbol list containing only the given symbols.

The list does not need to be sorted.

Panics

The call panics if the slice contains more elements than symbol sizes exist.

pub fn iter(&self) -> impl Iterator<Item = SymbolSize> + '_

pub fn is_empty(&self) -> bool

pub fn all() -> Self

Get a list with all supported symbol sizes.

pub fn contains(&self, symbol_size: &SymbolSize) -> bool

Check if a symbol size is in this symbol list.

Trait Implementations

impl Clone for SymbolList

fn clone(&self) -> SymbolList

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolList

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

Formats the value using the given formatter.

impl Default for SymbolList

fn default() -> Self

Create a symbol list with all but the DMRE symbol sizes.

impl Extend<SymbolSize> for SymbolList

fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = SymbolSize>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<const N: usize> From<[SymbolSize; N]> for SymbolList

fn from(other: [SymbolSize; N]) -> SymbolList

Performs the conversion.

impl From<SymbolSize> for SymbolList

fn from(size: SymbolSize) -> SymbolList

Performs the conversion.

impl FromIterator<SymbolSize> for SymbolList

fn from_iter<T: IntoIterator<Item = SymbolSize>>(iter: T) -> Self

Creates a value from an iterator.

impl IntoIterator for SymbolList

type Item = SymbolSize

The type of the elements being iterated over.

type IntoIter = <BTreeSet<SymbolSize> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<SymbolList> for SymbolList

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for SymbolList

impl StructuralEq for SymbolList

impl StructuralPartialEq for SymbolList