qrkit/types

Configuration enums shared by the qrkit public API and internal modules.

These intentionally live in a leaf module so that both qrkit and every qrkit/internal/* module can import them without creating a cycle.

Types

QR Code error correction level.

pub type ErrorCorrection {
  Low
  Medium
  Quartile
  High
}

Constructors

  • Low
  • Medium
  • Quartile
  • High

Data encoding mode.

pub type Mode {
  Numeric
  Alphanumeric
  Byte
  Kanji
}

Constructors

  • Numeric
  • Alphanumeric
  • Byte
  • Kanji

Encoder strategy hint.

pub type ModePreference {
  Auto
  ForceByte
}

Constructors

  • Auto
  • ForceByte

How build chooses among the rMQR sizes that hold the payload when no exact version is set.

pub type RectangularPriority {
  SmallestArea
  ShortestHeight
  NarrowestWidth
}

Constructors

  • SmallestArea

    The fewest modules (width x height); ties go to the lower symbol.

  • ShortestHeight

    The lowest symbol (7 modules first); ties go to the narrower one.

  • NarrowestWidth

    The narrowest symbol (27 modules first); ties go to the lower one.

Symbol family.

pub type Symbol {
  Standard
  Micro
  Rectangular
}

Constructors

  • Standard
  • Micro
  • Rectangular
✨ Search Document