kaitai 0.1.2

A macro for compiling Kaitai Struct into 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

use thiserror::Error;

/// The type returned by [`KaitaiStruct`](crate::runtime::KaitaiStruct) functions.
pub type Result<T> = std::result::Result<T, KaitaiError>;

/// Enum representing the potential errors emitted by this crate.
#[derive(Debug, Error)]
pub enum KaitaiError {
    /// Returned by the `read_byte_term` function in [`KaitaiStream`](crate::runtime::KaitaiStream)
    /// when the cursor reaches the end of the buffer before the terminator is reached. This should
    /// not necessarily be treated as an error but it should be differentiated from an
    /// [`IoError`](KaitaiError::IoError).
    #[error("end of stream reached, but no terminator {0} found")]
    EofBeforeTerminator(char),

    /// Returned by the `ensure_fixed_contents` function in `KaitaiStream` when the contents of the
    /// file don't match the expected value.
    #[error("unexpected fixed contents got {actual:?}, was expecting {expected:?}")]
    UnexpectedContents {
        /// The actual value read in
        actual: Vec<u8>,
        /// The expected value
        expected: Vec<u8>,
    },

    /// A generic IO error.
    #[error(transparent)]
    IoError(#[from] std::io::Error),
}