Struct ValidityFlag 

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

A validity flag that can be shared across multiple system parameters and checked to ensure they’re only used during system execution.

Also tracks whether the parameter has read-only or mutable access, enabling runtime enforcement of Bevy’s read/write semantics.

Implementations

impl ValidityFlag

pub fn new() -> Self

Create a new validity flag, initially set to Invalid

pub fn new_read() -> Self

Create a new validity flag for read-only access

pub fn new_write() -> Self

Create a new validity flag for mutable (read+write) access

pub fn with_access_mode(&self, access_mode: AccessMode) -> ValidityFlagWithMode

Create a wrapper that shares the same validity state but enforces a specific access mode

This is used for query parameters where the master validity is managed by ValidityGuard, but each parameter needs its own read/write restrictions.

pub fn get_mode(&self) -> AccessMode

Get the current access mode

pub fn check_read(&self) -> Result<(), StorageError>

Check if the flag allows read access

Returns Ok(()) if valid for reading (Read or Write mode), Err if Invalid.

pub fn check_write(&self) -> Result<(), StorageError>

Check if the flag allows write access

Returns Ok(()) if valid for writing (Write mode only), Err otherwise.

pub fn check(&self) -> Result<(), StorageError>

Legacy check method for backward compatibility (checks read access)

Returns Ok(()) if valid for reading, Err if Invalid.

pub fn set_invalid(&self)

Set the validity flag to Invalid

Trait Implementations

impl Clone for ValidityFlag

fn clone(&self) -> ValidityFlag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidityFlag

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

Formats the value using the given formatter.

impl Default for ValidityFlag

fn default() -> Self

Returns the “default value” for a type.