Expand description
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.
Structs§
- Annotation
- One annotation, retaining its unresolved type index, element order, and source range.
- Annotation
Default Attribute - An
AnnotationDefaultpayload. - Annotation
Element - One annotation element-name/value pair, retained in classfile order.
- Annotations
Attribute - An ordered
RuntimeVisibleAnnotationsorRuntimeInvisibleAnnotationspayload. - Attribute
Error - A located structured-attribute format error.
- Attribute
Location - Stable owner and order evidence for a retained attribute.
- Attribute
Origin - The absolute half-open byte range occupied by one annotation structure.
- Attribute
Shell - An uninterpreted attribute spine entry, retained in its original order.
- Bootstrap
Method - One bootstrap method and its ordered, arity-preserving constant-pool arguments.
- Bootstrap
Methods Attribute - An ordered
BootstrapMethodspayload. - Byte
Attribute - An opaque byte payload, used by
SourceDebugExtension. - Byte
Error - A byte-lane error located at an absolute input or output offset.
- Byte
Reader - A zero-copy big-endian reader confined to one declared byte region.
- Byte
Writer - A checked big-endian writer with a hard output budget.
- Class
Index - A constant-pool index proven to name a
Classentry. - Class
Shell - The bounded structural classfile read, before any shell index is checked.
- Classfile
Codec - Binary JVM classfile decoder/encoder exposed as
codec/classfile. - Classfile
Codec Lib - Host-registered library that installs the codec object and its browse Shapes.
- Code
Attribute - The ordered, index-preserving body of a JVM
Codeattribute. - Code
Exception - One
Codeexception-table row, with all offsets and the catch index retained verbatim. - Constant
Pool - An index-preserving constant pool whose
slots()[index]is the physical JVM slot. - Constant
Pool Error - A typed constant-pool failure located at the entry that caused it.
- Decoded
Code - A decoded code array and its exact first-byte lookup map.
- Edit
Report - Result of one checked method-body edit.
- Enclosing
Method Attribute - The
EnclosingMethodpayload; a zero method index denotes no specific method. - Exception
Handler Range - Raw Code-attribute exception-table offsets to validate against decoded instructions.
- Field
Shell - A raw field declaration whose indices have not been validated.
- Index
Attribute - A standard attribute whose payload is exactly one unresolved constant-pool index.
- Index
List Attribute - An ordered list of unresolved indices (
Exceptions,NestMembers,PermittedSubclasses, orModulePackages). - Inner
Class - One
InnerClassestable row. - Inner
Classes Attribute - The ordered
InnerClassespayload. - Instruction
- A decoded instruction whose shape was selected by generated manifest metadata.
- Instruction
Error - A byte-located instruction decoding error.
- Instruction
Id - Stable identity assigned in bytecode order within one decoded code array.
- Layout
Invalidation - Checked evidence invalidated by a classfile edit.
- Line
Number - One source line mapping in a
LineNumberTable. - Line
Number Table Attribute - An ordered
LineNumberTablepayload. - Local
Variable - One local-variable range, shared by
LocalVariableTableandLocalVariableTypeTable. - Local
Variable Target - One local-variable target range.
- Local
Variables Attribute - An ordered local-variable table payload.
- Located
Instruction - An instruction paired with its stable identity and first byte offset.
- Marker
Attribute - A marker attribute (
SyntheticorDeprecated), whose payload must be empty. - Method
Parameter - One
MethodParametersrow. - Method
Parameters Attribute - The ordered
MethodParameterspayload. - Method
Shell - A raw method declaration whose indices have not been validated.
- Module
Attribute - The complete structural
Modulepayload. - Module
Export - One
exportsoropensdirective in aModuleattribute. - Module
Provide - One
providesdirective in aModuleattribute. - Module
Require - One
requiresdirective in aModuleattribute. - Nested
Attribute - A nested attribute retained in declaration order with an unresolved name index.
- Opcode
Metadata - Generated metadata for one JVM opcode byte.
- Parameter
Annotations Attribute - An ordered
RuntimeVisibleParameterAnnotationsorRuntimeInvisibleParameterAnnotationspayload. - Record
Attribute - The ordered
Recordpayload. - Record
Component - One component in a
Recordattribute. - Shell
Budget - Limits for allocations made while structurally decoding one classfile shell.
- Shell
Error - A located shell failure, optionally naming the offending raw index.
- Stack
MapTable Attribute - An ordered
StackMapTablepayload. - Type
Annotation - One type annotation, including its target union and component path.
- Type
Annotations Attribute - An ordered runtime-visible or runtime-invisible type-annotation payload.
- Type
Path Entry - One step in a type annotation’s path from the annotated type to its target component.
- Utf8
Index - A constant-pool index proven to name a
Utf8entry. - Validated
Class Shell - Typed shell references produced only after structural decoding succeeds.
- Validated
Field Shell - A field projection whose name, descriptor, and attribute names are typed.
- Validated
Method Shell - A method projection whose name, descriptor, and attribute names are typed.
Enums§
- Attribute
Error Kind - A stable structured-attribute failure category.
- Attribute
Owner - The legal classfile owner of an attribute shell.
- Byte
Error Kind - A precise byte-lane failure category.
- Constant
- One usable JVM constant-pool entry.
- Constant
Pool Error Kind - A stable constant-pool failure category.
- Constant
Slot - One physical constant-pool index, including indices that cannot be referenced.
- Element
Value - A JVM annotation
element_value, with every constant-pool index left unresolved. - Instruction
Error Kind - Stable instruction decoding failure category.
- Instruction
Operand - One decoded operand, retaining its semantic role from the opcode manifest.
- Nested
Attribute Owner - Legal owners for attributes nested inside structured attribute bodies.
- Opcode
- Stable identity for every byte in the JVM opcode space.
- Shell
Error Kind - Stable failure category for shell decoding and validation.
- Stack
MapFrame - One compressed stack-map frame, retained without expansion.
- Type
Annotation Target - The complete target-specific union from JVMS
target_info. - Verification
Type - A verifier type exactly as represented by
verification_type_info.
Constants§
- FIXTURE_
EXPECTATIONS - Independently authored expectations for every retained fixture.
- MAX_
ANNOTATION_ NESTING - Maximum annotation nesting accepted even when a caller supplies a larger budget.
- SCOPE
- Machine-readable format bounds and reuse decisions.
Statics§
- OPCODES
- Complete byte-indexed opcode metadata table.
- RECIPES
- Cookbook recipes embedded for runtime help and browse surfaces.
Functions§
- decode_
instructions - Decode JVM instructions using generated metadata plus the three irregular layouts.
- decode_
modified_ utf8 - Decode strict JVM modified UTF-8 into exact UTF-16 code units.
- encode_
instructions - Encode a decoded instruction stream after recomputing offsets, switch padding, and branches.
- encode_
modified_ utf8 - Encode exact, well-formed UTF-16 code units as strict JVM modified UTF-8.
- inspect_
classfile - Decode retained classfile bytes into bounded Table/Dir-compatible data.
- standard_
attribute_ min_ major - Earliest classfile major version for a standard attribute.
- validate_
exception_ handlers - Validate Code-attribute exception ranges against an already decoded code array.
Type Aliases§
- Record
Component Attribute - One nested attribute attached to a record component.