sim-codec-classfile 0.1.0

Bounded, lossless Java Virtual Machine classfile codec for SIM
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

//! Frozen scope contract for the bounded, lossless JVM classfile codec.
//!
//! Parsing is intentionally introduced only after the retained corpus and its
//! independently authored expectations have been fixed.

#![forbid(unsafe_code)]
#![deny(missing_docs)]

mod attribute;
mod bytes;
mod constant;
mod encode;
mod instruction;
mod modified_utf8;
mod opcode_generated;
mod runtime;
mod shell;

pub use attribute::{
    Annotation, AnnotationDefaultAttribute, AnnotationElement, AnnotationsAttribute,
    AttributeError, AttributeErrorKind, AttributeOrigin, BootstrapMethod,
    BootstrapMethodsAttribute, ByteAttribute, CodeAttribute, CodeException, ElementValue,
    EnclosingMethodAttribute, IndexAttribute, IndexListAttribute, InnerClass,
    InnerClassesAttribute, LineNumber, LineNumberTableAttribute, LocalVariable,
    LocalVariableTarget, LocalVariablesAttribute, MAX_ANNOTATION_NESTING, MarkerAttribute,
    MethodParameter, MethodParametersAttribute, ModuleAttribute, ModuleExport, ModuleProvide,
    ModuleRequire, NestedAttribute, NestedAttributeOwner, ParameterAnnotationsAttribute,
    RecordAttribute, RecordComponent, RecordComponentAttribute, StackMapFrame,
    StackMapTableAttribute, TypeAnnotation, TypeAnnotationTarget, TypeAnnotationsAttribute,
    TypePathEntry, VerificationType, standard_attribute_min_major,
};
pub use bytes::{ByteError, ByteErrorKind, ByteReader, ByteWriter};
pub use constant::{
    Constant, ConstantPool, ConstantPoolError, ConstantPoolErrorKind, ConstantSlot,
};
pub use encode::encode_instructions;
pub use instruction::{
    DecodedCode, ExceptionHandlerRange, Instruction, InstructionError, InstructionErrorKind,
    InstructionId, InstructionOperand, LocatedInstruction, decode_instructions,
    validate_exception_handlers,
};
pub use modified_utf8::{decode_modified_utf8, encode_modified_utf8};
pub use opcode_generated::{OPCODES, Opcode, OpcodeMetadata};
pub use runtime::{ClassfileCodec, ClassfileCodecLib, inspect_classfile};
pub use shell::{
    AttributeLocation, AttributeOwner, AttributeShell, ClassIndex, ClassShell, EditReport,
    FieldShell, LayoutInvalidation, MethodShell, ShellBudget, ShellError, ShellErrorKind,
    Utf8Index, ValidatedClassShell, ValidatedFieldShell, ValidatedMethodShell,
};

/// Machine-readable format bounds and reuse decisions.
pub const SCOPE: &str = include_str!("../scope.toml");

/// Independently authored expectations for every retained fixture.
pub const FIXTURE_EXPECTATIONS: &str = include_str!("../fixtures/expectations.toml");

/// Cookbook recipes embedded for runtime help and browse surfaces.
pub static RECIPES: sim_cookbook::EmbeddedDir =
    include!(concat!(env!("OUT_DIR"), "/cookbook_recipes.rs"));

#[cfg(test)]
mod tests;