qubit-io 0.5.0

Small stream I/O trait utilities for Rust
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

/*******************************************************************************
 *
 *    Copyright (c) 2026 Haixing Hu.
 *
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0.
 *
******************************************************************************/
use thiserror::Error;

use crate::Leb128DecodeErrorKind;

/// Error reported while decoding a LEB128 integer from a byte buffer.
#[derive(Clone, Copy, Debug, Eq, Error, PartialEq)]
#[error("{kind}")]
pub struct Leb128DecodeError {
    kind: Leb128DecodeErrorKind,
    index: usize,
}

impl Leb128DecodeError {
    /// Creates a LEB128 decoding error.
    ///
    /// # Parameters
    ///
    /// - `kind`: Failure category.
    /// - `index`: Absolute byte index at which the failure was detected.
    ///
    /// # Returns
    ///
    /// Returns a decoding error carrying the supplied context.
    #[inline]
    pub const fn new(kind: Leb128DecodeErrorKind, index: usize) -> Self {
        Self { kind, index }
    }

    /// Returns the decoding error kind.
    #[must_use]
    #[inline]
    pub const fn kind(self) -> Leb128DecodeErrorKind {
        self.kind
    }

    /// Returns the absolute byte index associated with this error.
    #[must_use]
    #[inline]
    pub const fn index(self) -> usize {
        self.index
    }
}