Struct FieldAccessFlags 

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

Field access flags used in Java class files to specify the access permissions and properties of fields.

These flags determine visibility (public, private, protected), mutability (final),and other characteristics of class fields. Multiple flags can be combined using bitwise OR operations.

Examples

Creating field access flags for common field types:

use ristretto_classfile::FieldAccessFlags;
use std::io::Cursor;

// A private final instance field
let flags = FieldAccessFlags::PRIVATE | FieldAccessFlags::FINAL;

// Check if specific flags are set
assert!(flags.contains(FieldAccessFlags::PRIVATE));
assert!(flags.contains(FieldAccessFlags::FINAL));
assert!(!flags.contains(FieldAccessFlags::PUBLIC));
assert!(!flags.contains(FieldAccessFlags::STATIC));

// Get a code representation
assert_eq!("private final", flags.as_code());

// Serialize to bytes
let mut bytes = Vec::new();
flags.to_bytes(&mut bytes)?;
assert_eq!(vec![0x00, 0x12], bytes); // 0x0012 = PRIVATE | FINAL

// Deserialize from bytes
let mut cursor = Cursor::new(bytes);
let deserialized = FieldAccessFlags::from_bytes(&mut cursor)?;
assert_eq!(flags, deserialized);

// Display as string
assert_eq!("(0x0012) ACC_PRIVATE, ACC_FINAL", flags.to_string());

References

See: https://docs.oracle.com/javase/specs/jvms/se25/html/jvms-4.html#jvms-4.5:~:text=field_info%20structure%20are%20as%20follows%3A-,access_flags,-The%20value%20of%20the%20access_flags

Implementations

impl FieldAccessFlags

pub const PUBLIC: FieldAccessFlags

Declared public; may be accessed from outside its package.

pub const PRIVATE: FieldAccessFlags

Declared private; accessible only within the defining class and other classes belonging to the same nest (§5.4.4).

pub const PROTECTED: FieldAccessFlags

Declared protected; may be accessed within subclasses.

pub const STATIC: FieldAccessFlags

Declared static.

pub const FINAL: FieldAccessFlags

Declared final; never directly assigned to after object construction (JLS §17.5).

pub const VOLATILE: FieldAccessFlags

Declared volatile; cannot be cached.

pub const TRANSIENT: FieldAccessFlags

Declared transient; not written or read by a persistent object manager.

pub const SYNTHETIC: FieldAccessFlags

Declared synthetic; not present in the source code.

pub const ENUM: FieldAccessFlags

Declared as an element of an enum class.

impl FieldAccessFlags

pub const fn empty() -> FieldAccessFlags

Get a flags value with all bits unset.

pub const fn all() -> FieldAccessFlags

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<FieldAccessFlags>

Convert from a bits value.

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

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

Convert from a bits value, unsetting any unknown bits.

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

Convert from a bits value exactly.

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

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: FieldAccessFlags) -> bool

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

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

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

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

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

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

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: FieldAccessFlags)

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

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

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

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

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

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

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

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

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: FieldAccessFlags, ) -> FieldAccessFlags

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

pub const fn complement(self) -> FieldAccessFlags

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

impl FieldAccessFlags

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

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<FieldAccessFlags>

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 FieldAccessFlags

pub fn from_bytes( bytes: &mut Cursor<Vec<u8>>, ) -> Result<FieldAccessFlags, Error>

Deserialize the FieldAccessFlags from bytes.

Reads a u16 value from the given cursor in big-endian order and constructs a FieldAccessFlags instance from it.

Errors

Should not occur; reserved for future use.

Examples

use std::io::Cursor;
use ristretto_classfile::FieldAccessFlags;

// Create a byte buffer representing a public static field
let access_flags: u16 = 0x0009; // PUBLIC | STATIC
let mut bytes = Cursor::new(access_flags.to_be_bytes().to_vec());

// Parse the access flags
let flags = FieldAccessFlags::from_bytes(&mut bytes)?;
assert!(flags.contains(FieldAccessFlags::PUBLIC));
assert!(flags.contains(FieldAccessFlags::STATIC));

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

Serialize the FieldAccessFlags to bytes.

Writes the flags as a u16 value in big-endian order to the given byte vector.

Examples

use ristretto_classfile::FieldAccessFlags;

// Create a flags instance representing a public final field
let flags = FieldAccessFlags::PUBLIC | FieldAccessFlags::FINAL;

// Serialize to bytes
let mut bytes = Vec::new();
flags.to_bytes(&mut bytes)?;

// Check the serialized value (0x0011 = PUBLIC | FINAL)
assert_eq!(bytes, [0x00, 0x11]);

Errors

Should not occur; reserved for future use.

pub fn as_code(&self) -> String

Get the FieldAccessFlags as a string of Java modifiers.

This method converts the flags to a string representation that matches how the modifiers would appear in Java source code.

Examples

use ristretto_classfile::FieldAccessFlags;

// Public static final field (common for constants)
let flags = FieldAccessFlags::PUBLIC | FieldAccessFlags::STATIC | FieldAccessFlags::FINAL;
assert_eq!("public static final", flags.as_code());

// Private volatile field
let flags = FieldAccessFlags::PRIVATE | FieldAccessFlags::VOLATILE;
assert_eq!("private volatile", flags.as_code());

// Flags without Java modifiers return empty strings
assert_eq!("", FieldAccessFlags::empty().as_code());

Trait Implementations

impl Binary for FieldAccessFlags

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

Formats the value using the given formatter.

impl BitAnd for FieldAccessFlags

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

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

type Output = FieldAccessFlags

The resulting type after applying the & operator.

impl BitAndAssign for FieldAccessFlags

fn bitand_assign(&mut self, other: FieldAccessFlags)

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

impl BitOr for FieldAccessFlags

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

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

type Output = FieldAccessFlags

The resulting type after applying the | operator.

impl BitOrAssign for FieldAccessFlags

fn bitor_assign(&mut self, other: FieldAccessFlags)

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

impl BitXor for FieldAccessFlags

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

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

type Output = FieldAccessFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for FieldAccessFlags

fn bitxor_assign(&mut self, other: FieldAccessFlags)

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

impl Clone for FieldAccessFlags

fn clone(&self) -> FieldAccessFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldAccessFlags

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

Formats the value using the given formatter.

impl Default for FieldAccessFlags

fn default() -> FieldAccessFlags

Creates a new FieldAccessFlags with no flags set.

Examples

use ristretto_classfile::FieldAccessFlags;

let flags = FieldAccessFlags::default();
assert!(flags.is_empty());
assert_eq!(0, flags.bits());

impl Display for FieldAccessFlags

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

Formats the FieldAccessFlags as a string showing the hexadecimal value and the individual flag constants.

Examples

use ristretto_classfile::FieldAccessFlags;

// Public static field
let flags = FieldAccessFlags::PUBLIC | FieldAccessFlags::STATIC;
assert_eq!("(0x0009) ACC_PUBLIC, ACC_STATIC", flags.to_string());

// Private final field
let flags = FieldAccessFlags::PRIVATE | FieldAccessFlags::FINAL;
assert_eq!("(0x0012) ACC_PRIVATE, ACC_FINAL", flags.to_string());

impl Extend<FieldAccessFlags> for FieldAccessFlags

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

where T: IntoIterator<Item = FieldAccessFlags>,

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 FieldAccessFlags

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

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) -> FieldAccessFlags

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 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<FieldAccessFlags> for FieldAccessFlags

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

where T: IntoIterator<Item = FieldAccessFlags>,

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

impl IntoIterator for FieldAccessFlags

type Item = FieldAccessFlags

The type of the elements being iterated over.

type IntoIter = Iter<FieldAccessFlags>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl LowerHex for FieldAccessFlags

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

Formats the value using the given formatter.

impl Not for FieldAccessFlags

fn not(self) -> FieldAccessFlags

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

type Output = FieldAccessFlags

The resulting type after applying the ! operator.

impl Octal for FieldAccessFlags

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

Formats the value using the given formatter.

impl PartialEq for FieldAccessFlags

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

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

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 = FieldAccessFlags

The resulting type after applying the - operator.

impl SubAssign for FieldAccessFlags

fn sub_assign(&mut self, other: FieldAccessFlags)

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 FieldAccessFlags

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

Formats the value using the given formatter.

impl Copy for FieldAccessFlags

impl Eq for FieldAccessFlags

impl StructuralPartialEq for FieldAccessFlags