weakauras-codec-base64 0.1.0

Provides heavily optimized routines for decoding and encoding base64 used for WeakAuras-compatible strings.
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

// Copyright 2025 Velithris
// SPDX-License-Identifier: MIT

use core::fmt;
#[cfg(any(test, feature = "std"))]
use std::error;

/// Errors than can occur while decoding.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum DecodeError {
    /// An invalid byte was found in the input. Its offset is provided.
    InvalidByte(usize),
    /// The input's length is invalid.
    InvalidLength,
}

impl fmt::Display for DecodeError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match *self {
            Self::InvalidByte(offset) => write!(f, "Invalid byte at offset {}", offset),
            Self::InvalidLength => write!(f, "Invalid length"),
        }
    }
}

#[cfg(any(test, feature = "std"))]
impl error::Error for DecodeError {}

/// Errors than can occur while decoding into a slice.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum DecodeIntoSliceError {
    /// A [DecodeError] occurred.
    DecodeError(DecodeError),
    /// The provided slice is too small.
    OutputSliceIsTooSmall,
}

impl From<DecodeError> for DecodeIntoSliceError {
    fn from(e: DecodeError) -> Self {
        Self::DecodeError(e)
    }
}

impl fmt::Display for DecodeIntoSliceError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Self::DecodeError(inner) => inner.fmt(f),
            Self::OutputSliceIsTooSmall => write!(f, "Output slice is too small"),
        }
    }
}

#[cfg(any(test, feature = "std"))]
impl error::Error for DecodeIntoSliceError {
    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
        match self {
            Self::DecodeError(inner) => Some(inner),
            Self::OutputSliceIsTooSmall => None,
        }
    }
}

/// Errors than can occur while encoding.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum EncodeError {
    /// Encoding the input would require more than [usize::MAX] bytes of output.
    DataIsTooLarge,
}

impl fmt::Display for EncodeError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Self::DataIsTooLarge => write!(f, "Data is too large"),
        }
    }
}

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

/// Errors than can occur while encoding into a slice.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum EncodeIntoSliceError {
    /// An [EncodeError] occurred.
    EncodeError(EncodeError),
    /// The provided slice is too small.
    OutputSliceIsTooSmall,
}

impl From<EncodeError> for EncodeIntoSliceError {
    fn from(e: EncodeError) -> Self {
        Self::EncodeError(e)
    }
}

impl fmt::Display for EncodeIntoSliceError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Self::EncodeError(inner) => inner.fmt(f),
            Self::OutputSliceIsTooSmall => write!(f, "Output slice is too small"),
        }
    }
}

#[cfg(any(test, feature = "std"))]
impl error::Error for EncodeIntoSliceError {
    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
        match self {
            Self::EncodeError(inner) => Some(inner),
            Self::OutputSliceIsTooSmall => None,
        }
    }
}