barcodes 0.2.0

Universal Bar/QR codes library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

//! Common error types for barcode encoding.
//!
//! The error type is allocation-free: it carries only `Copy` payloads so the
//! zero-allocation core never touches the heap.
#![forbid(unsafe_code)]

use core::fmt;

/// A generic encoding error returned when barcode encoding fails.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum EncodeError {
    /// The input data is invalid for this symbology (e.g. wrong length).
    InvalidInput(&'static str),
    /// The input contained a character that is not encodable in this symbology.
    InvalidCharacter(char),
    /// The input data is too long to be encoded.
    DataTooLong,
    /// The caller-provided output buffer is too small for the encoded symbol.
    BufferTooSmall,
}

impl fmt::Display for EncodeError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            EncodeError::InvalidInput(msg) => write!(f, "invalid input: {msg}"),
            EncodeError::InvalidCharacter(ch) => write!(f, "invalid character: '{ch}'"),
            EncodeError::DataTooLong => write!(f, "data too long to encode"),
            EncodeError::BufferTooSmall => write!(f, "output buffer too small"),
        }
    }
}

#[cfg(feature = "std")]
impl std::error::Error for EncodeError {}