FerroBabe 0.1.3

A lightweight Rust library for disassembling Java class files.
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

use rust_asm::error::ClassReadError;
use thiserror::Error;

#[derive(Debug, Error)]
/// Errors that prevent FerroBabe from returning the requested result.
pub enum FerroBabeError {
    /// The byte sequence ended before the eight-byte class-file header was available.
    #[error("class input is too short: expected at least {required} bytes, found {actual}")]
    InputTooShort {
        /// Minimum number of bytes required for the header.
        required: usize,
        /// Number of bytes supplied by the caller.
        actual: usize,
    },

    /// The input header did not contain the Java class-file magic value.
    #[error("input is not a Java class file: found magic 0x{found:08x}")]
    InvalidMagic {
        /// Four-byte value read from the input header.
        found: u32,
    },

    /// The class-file major version is outside FerroBabe's supported range.
    #[error(
        "unsupported Java class-file version {major}.{minor}; FerroBabe supports 45.0 through 70.65535"
    )]
    UnsupportedVersion {
        /// Unsupported class-file major version.
        major: u16,
        /// Class-file minor version paired with `major`.
        minor: u16,
    },

    /// Reading from a caller-provided [`std::io::Read`] source failed.
    #[error("class input could not be read: {source}")]
    InputRead {
        #[source]
        /// Source reader error.
        source: std::io::Error,
    },

    /// The underlying class-file decoder rejected the input.
    #[error("class-file decoding failed: {source}")]
    Decode {
        #[source]
        /// Underlying decoder error.
        source: ClassReadError,
    },

    /// A formatter could not write to its [`std::fmt::Write`] destination.
    #[error("formatted output could not be written")]
    Format {
        #[source]
        /// Formatting destination error.
        source: std::fmt::Error,
    },

    /// Text output was requested for a partial result that has no complete class model.
    #[error("a partial class-file result cannot be formatted")]
    IncompleteDisassembly,
}