qrkit - v0.6.0

qrkit/error

Errors returned by qrkit’s public API.

Types

DecodeError

</>

Errors returned by qrkit/decode.

pub type DecodeError {
  NotASymbol(width: Int, height: Int)
  UnreadableFormatInformation
  TooManyErrors
  MalformedData(reason: String)
}

Constructors 

  • NotASymbol(width: Int, height: Int)

    The matrix is not rectangular, or its size matches no Standard QR, Micro QR or rMQR symbol (after the quiet zone is removed).

  • UnreadableFormatInformation

    Neither copy of the format information is within the BCH code’s correction distance of a valid value, in any orientation.

  • TooManyErrors

    A Reed-Solomon block has more errors than it can correct.

  • MalformedData(reason: String)

    The corrected data does not follow the symbol’s bit stream grammar (unknown mode, truncated segment, out-of-range digit group, or a Kanji value outside JIS X 0208).

EncodeError

</>

Errors returned while building a QR code.

pub type EncodeError {
  DataExceedsCapacity(bits_needed: Int, bits_available: Int)
  InvalidVersion(requested: Int)
  InvalidEciDesignator(designator: Int)
  UnsupportedCharacter(at_index: Int, character: String)
  EmptyInput
  IncompatibleOptions(reason: String)
}

Constructors 

  • DataExceedsCapacity(bits_needed: Int, bits_available: Int)
  • InvalidVersion(requested: Int)
  • InvalidEciDesignator(designator: Int)
  • UnsupportedCharacter(at_index: Int, character: String)
  • EmptyInput
  • IncompatibleOptions(reason: String)

MatrixAccessError

</>

Errors returned while reading individual modules from a QR matrix.

pub type MatrixAccessError {
  ModuleOutOfBounds(x: Int, y: Int, width: Int, height: Int)
}

Constructors 

  • ModuleOutOfBounds(x: Int, y: Int, width: Int, height: Int)
✨ Search Document