Struct ConstantPool

pub struct ConstantPool { /* private fields */ }

A JVM constant pool. See the JVM Specification §4.4 for more information.

Implementations

impl ConstantPool

pub fn new() -> Self

Creates a new empty constant pool.

pub fn with_capacity(count: u16) -> Self

Creates a new constant pool with the given capacity.

Parameters

• count: the maximum index of entries in the constant pool plus one.

pub fn from_reader<R>(reader: &mut R, constant_pool_count: u16) -> Result<Self>

where R: Read + ?Sized,

Parses a constant pool from the given bytes.

• constant_pool_count is the maximum index of entries in the constant pool plus one. See the JVM Specification §4.1 for more information.

Errors

See io::Error for more information.

pub fn get_entry(&self, index: u16) -> Option<&Entry>

Gets the constant pool entry at the given index.

Returns None if the index is out of bounds or the index does not point to a valid slot.

pub fn put_entry(&mut self, entry: Entry) -> Result<u16, Overflow>

Put a constant pool entry to the end of the constant pool and return the index of the inserted entry.

Errors

Returns back the entry if the constant pool is full (i.e., contains more than 65535 slots).

pub fn put_entry_deduplicated( &mut self, entry: Entry, ) -> Result<(u16, bool), Overflow>

Pushes a constant pool entry to the end of the constant pool if it does not already exist.

Return Values

Ok with a tuple indicating the index of the entry within the constant pool, and whether the entry is freshly inserted into the pool.

Errors

Returns back the entry if the constant pool is full (i.e., contains more than 65535 slots).

pub fn find<P>(&self, predicate: P) -> Option<(u16, &Entry)>

where P: Fn(&Entry) -> bool,

Finds the first constant pool entry that satisfies the given predicate.

pub fn count(&self) -> u16

Gets the count of the constant pool. Note that this is NOT the number of entries. See the JVM Specification §4.1 for more information.

Trait Implementations

impl Clone for ConstantPool

fn clone(&self) -> ConstantPool

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConstantPool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ConstantPool

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ConstantPool

fn eq(&self, other: &ConstantPool) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ConstantPool

impl StructuralPartialEq for ConstantPool