Struct ModuleFlags 

pub struct ModuleFlags(/* private fields */);

Module access flags used in Java class files.

The ModuleAccessFlags type represents the access flags in the Module attribute of a Java class file.

Examples

use ristretto_classfile::byte_reader::ByteReader;
use ristretto_classfile::attributes::ModuleAccessFlags;

// Create flags using individual constants
let flags = ModuleAccessFlags::OPEN | ModuleAccessFlags::SYNTHETIC;

// Test for specific flags
assert!(flags.contains(ModuleAccessFlags::OPEN));
assert!(flags.contains(ModuleAccessFlags::SYNTHETIC));
assert!(!flags.contains(ModuleAccessFlags::MANDATED));

// Convert to string representation
assert_eq!(flags.to_string(), "(0x1020) ACC_OPEN, ACC_SYNTHETIC");

// Serialize to bytes
let mut bytes = Vec::new();
flags.to_bytes(&mut bytes)?;
assert_eq!(bytes, vec![0x10, 0x20]);

// Deserialize from bytes
let mut reader = ByteReader::new(&bytes);
let deserialized = ModuleAccessFlags::from_bytes(&mut reader)?;
assert_eq!(deserialized, flags);

References

• JVMS §4.7.25

Implementations

impl ModuleAccessFlags

pub const OPEN: ModuleAccessFlags

Indicates that this module is open.

pub const SYNTHETIC: ModuleAccessFlags

Indicates that this module was not explicitly or implicitly declared.

pub const MANDATED: ModuleAccessFlags

Indicates that this module was implicitly declared.

impl ModuleAccessFlags

pub const fn empty() -> ModuleAccessFlags

Get a flags value with all bits unset.

pub const fn all() -> ModuleAccessFlags

Get a flags value with all known bits set.

pub const fn bits(&self) -> u16

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u16) -> Option<ModuleAccessFlags>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u16) -> ModuleAccessFlags

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u16) -> ModuleAccessFlags

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<ModuleAccessFlags>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: ModuleAccessFlags) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: ModuleAccessFlags) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: ModuleAccessFlags)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: ModuleAccessFlags)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: ModuleAccessFlags)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: ModuleAccessFlags, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: ModuleAccessFlags) -> ModuleAccessFlags

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: ModuleAccessFlags) -> ModuleAccessFlags

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: ModuleAccessFlags) -> ModuleAccessFlags

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference( self, other: ModuleAccessFlags, ) -> ModuleAccessFlags

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> ModuleAccessFlags

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl ModuleAccessFlags

pub const fn iter(&self) -> Iter<ModuleAccessFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<ModuleAccessFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl ModuleAccessFlags

pub fn from_bytes( bytes: &mut ByteReader<'_>, ) -> Result<ModuleAccessFlags, Error>

Deserialize the ModuleAccessFlags from bytes.

Errors

Should not occur; reserved for future use.

Examples

use ristretto_classfile::byte_reader::ByteReader;
use ristretto_classfile::attributes::ModuleAccessFlags;

let mut bytes = ByteReader::new(&[0x00, 0x20]); // ACC_OPEN
let flags = ModuleAccessFlags::from_bytes(&mut bytes)?;
assert_eq!(flags, ModuleAccessFlags::OPEN);

pub fn to_bytes(&self, bytes: &mut Vec<u8>) -> Result<(), Error>

Serialize the ModuleAccessFlags to bytes.

Errors

Should not occur; reserved for future use.

Examples

use ristretto_classfile::attributes::ModuleAccessFlags;

let flags = ModuleAccessFlags::OPEN | ModuleAccessFlags::SYNTHETIC;
let mut bytes = Vec::new();
flags.to_bytes(&mut bytes)?;
assert_eq!(bytes, vec![0x10, 0x20]); // 0x0020 | 0x1000

Trait Implementations

impl Binary for ModuleAccessFlags

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

Formats the value using the given formatter.

impl BitAnd for ModuleAccessFlags

fn bitand(self, other: ModuleAccessFlags) -> ModuleAccessFlags

The bitwise and (&) of the bits in two flags values.

type Output = ModuleAccessFlags

The resulting type after applying the & operator.

impl BitAndAssign for ModuleAccessFlags

fn bitand_assign(&mut self, other: ModuleAccessFlags)

The bitwise and (&) of the bits in two flags values.

impl BitOr for ModuleAccessFlags

fn bitor(self, other: ModuleAccessFlags) -> ModuleAccessFlags

The bitwise or (|) of the bits in two flags values.

type Output = ModuleAccessFlags

The resulting type after applying the | operator.

impl BitOrAssign for ModuleAccessFlags

fn bitor_assign(&mut self, other: ModuleAccessFlags)

The bitwise or (|) of the bits in two flags values.

impl BitXor for ModuleAccessFlags

fn bitxor(self, other: ModuleAccessFlags) -> ModuleAccessFlags

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = ModuleAccessFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for ModuleAccessFlags

fn bitxor_assign(&mut self, other: ModuleAccessFlags)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for ModuleAccessFlags

fn clone(&self) -> ModuleAccessFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleAccessFlags

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

Formats the value using the given formatter.

impl Default for ModuleAccessFlags

fn default() -> ModuleAccessFlags

Returns the “default value” for a type.

impl Display for ModuleAccessFlags

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

Implements the Display trait for ModuleAccessFlags, allowing flags to be printed in a human-readable format.

The output format consists of:

1. The hexadecimal value of the flags in parentheses (e.g., “(0x0020)”)
2. A list of named flags separated by commas (e.g., “ACC_OPEN, ACC_SYNTHETIC”)

Examples

use ristretto_classfile::attributes::ModuleAccessFlags;

let flags = ModuleAccessFlags::OPEN | ModuleAccessFlags::SYNTHETIC;

let output = flags.to_string();
assert_eq!(output, "(0x1020) ACC_OPEN, ACC_SYNTHETIC");

let empty = ModuleAccessFlags::empty();
assert_eq!(empty.to_string(), "(0x0000) ");

impl Extend<ModuleAccessFlags> for ModuleAccessFlags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = ModuleAccessFlags>,

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for ModuleAccessFlags

const FLAGS: &'static [Flag<ModuleAccessFlags>]

The set of defined flags.

type Bits = u16

The underlying bits type.

fn bits(&self) -> u16

Get the underlying bits value.

fn from_bits_retain(bits: u16) -> ModuleAccessFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<ModuleAccessFlags> for ModuleAccessFlags

fn from_iter<T>(iterator: T) -> ModuleAccessFlags

where T: IntoIterator<Item = ModuleAccessFlags>,

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for ModuleAccessFlags

type Item = ModuleAccessFlags

The type of the elements being iterated over.

type IntoIter = Iter<ModuleAccessFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <ModuleAccessFlags as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for ModuleAccessFlags

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

Formats the value using the given formatter.

impl Not for ModuleAccessFlags

fn not(self) -> ModuleAccessFlags

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = ModuleAccessFlags

The resulting type after applying the ! operator.

impl Octal for ModuleAccessFlags

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

Formats the value using the given formatter.

impl PartialEq for ModuleAccessFlags

fn eq(&self, other: &ModuleAccessFlags) -> 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 Sub for ModuleAccessFlags

fn sub(self, other: ModuleAccessFlags) -> ModuleAccessFlags

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = ModuleAccessFlags

The resulting type after applying the - operator.

impl SubAssign for ModuleAccessFlags

fn sub_assign(&mut self, other: ModuleAccessFlags)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for ModuleAccessFlags

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

Formats the value using the given formatter.

impl Copy for ModuleAccessFlags

impl Eq for ModuleAccessFlags

impl StructuralPartialEq for ModuleAccessFlags