vax-disassembler 0.1.1

DEC VAX one-line disassembler
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

//! # Disassembly Errors

use thiserror::Error;
use crate::{
    opcode::{AccessType, DataType},
    operand::Operand,
};

/// # VAX assembler/disassembler errors
///
/// # Examples
///
/// ```rust
/// use std::io::Cursor;
/// use vax_disassembler::{ReadMacro32, error::Error};
///
/// let invalid_opcode = Cursor::new([0x57]).disassemble();
/// assert!(invalid_opcode.is_err());
/// if let Err(Error::InvalidOpcode(0x57)) = invalid_opcode {} else { panic!(); }
/// ```
#[derive(Debug, Error)]
pub enum Error {
    /// # Invalid Opcode
    ///
    /// In the documention, all undefined opcodes are marked as "Reserved to DIGITAL", so this
    /// error is like a reserved operand error.
    #[error("Invalid opcode: {0:#X}")]
    InvalidOpcode(u16),

    /// # Invalid Opcode String
    ///
    /// In the documention, all undefined opcodes are marked as "Reserved to DIGITAL", so this
    /// error is like a reserved operand error.
    #[error("Invalid opcode: {0}")]
    InvalidOpcodeString(String),

    /// # Invalid Indexed Operand
    ///
    /// 
    #[error("Invalid indexed operand: {0:?}")]
    InvalidIndexedOperand(Operand),

    /// # Invalid Access Type and Data Type Combination
    #[error("Invalid access type and data size: access = {0:?}, size = {0:?}")]
    InvalidAccessSize(AccessType, DataType),

    /// # Unimplemented Feature
    ///
    /// This is an unimplemented feature. This error should go away once development is complete.
    #[error("Unimpleneted feature: {0}")]
    Unimplemented(&'static str),

    /// # Passtrhough I/O Error
    #[error("I/O error: {0}")]
    IoError(#[from] std::io::Error),
}

/// Error handling with the `Result` type for the [`enum@Error`] type.
pub type Result<T> = std::result::Result<T, Error>;