Enum QrError 

#[non_exhaustive]
pub enum QrError {
    DataTooLong,
    InvalidVersion {
        version: Version,
        ec_level: EcLevel,
    },
    UnsupportedCharacterSet,
    InvalidEciDesignator {
        value: u32,
    },
    InvalidCharacter {
        position: usize,
        byte: u8,
    },
    InvalidStructuredAppend {
        value: u8,
    },
}

QrError encodes the error encountered when generating a QR code.

This enum is #[non_exhaustive]: future versions may add variants, so external callers should match with a _ arm.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

DataTooLong

The data is too long to encode into a QR code for the given version.

InvalidVersion

The provided version / error correction level combination is invalid. Carries the offending Version and EcLevel.

Fields

version: Version

The version that was requested.

ec_level: EcLevel

The error-correction level that was requested.

UnsupportedCharacterSet

Some characters in the data cannot be supported by the provided QR code version.

InvalidEciDesignator

The provided ECI designator is invalid. Carries the offending value; a valid designator must be between 0 and 999999.

Fields

value: u32

The invalid ECI designator value.

InvalidCharacter

A character not belonging to the character set is found. Carries the byte position (offset into the input) and the offending byte value.

Fields

position: usize

Byte offset of the offending character within the input.

byte: u8

The offending byte value.

InvalidStructuredAppend

Invalid Structured Append parameter — the symbol count is not in 2..=16, or the position is not in 1..=total. Carries the offending value.

Fields

value: u8

The out-of-range symbol count or position.

Implementations

impl QrError

pub fn suggestion(&self) -> Option<&'static str>

Returns an actionable hint for fixing this error, if one applies — useful for surfacing user-facing guidance alongside the error message.

Examples

use qrcode_core::QrError;

let err = QrError::DataTooLong;
assert!(err.suggestion().is_some());

Trait Implementations

impl Clone for QrError

fn clone(&self) -> QrError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for QrError

impl Debug for QrError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QrError

fn deserialize<__D>( __deserializer: __D, ) -> Result<QrError, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for QrError

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

Formats the value using the given formatter.

impl Eq for QrError

impl Error for QrError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl PartialEq for QrError

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for QrError

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for QrError