Struct AttributeFlags 

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

Represents the flags defined in a PHP #[Attribute] declaration, specifying the targets where the attribute can be applied and whether it’s repeatable.

Implementations

impl AttributeFlags

pub const TARGET_CLASS: Self

Flag indicating the attribute can be applied to classes, interfaces, traits, and enums. Corresponds to Attribute::TARGET_CLASS.

pub const TARGET_FUNCTION: Self

Flag indicating the attribute can be applied to functions (including closures and arrow functions). Corresponds to Attribute::TARGET_FUNCTION.

pub const TARGET_METHOD: Self

Flag indicating the attribute can be applied to methods. Corresponds to Attribute::TARGET_METHOD.

pub const TARGET_PROPERTY: Self

Flag indicating the attribute can be applied to properties. Corresponds to Attribute::TARGET_PROPERTY.

pub const TARGET_CLASS_CONSTANT: Self

Flag indicating the attribute can be applied to class constants. Corresponds to Attribute::TARGET_CLASS_CONSTANT.

pub const TARGET_PARAMETER: Self

Flag indicating the attribute can be applied to function or method parameters. Corresponds to Attribute::TARGET_PARAMETER.

pub const TARGET_CONSTANT: Self

Flag indicating the attribute can be applied to global constants (defined with const). Corresponds to Attribute::TARGET_CONSTANT.

pub const TARGET_ALL: Self

A combination of all TARGET_* flags, indicating the attribute can be applied anywhere. Corresponds to Attribute::TARGET_ALL.

pub const IS_REPEATABLE: Self

Flag indicating the attribute can be repeated on the same declaration. Corresponds to Attribute::IS_REPEATABLE.

impl AttributeFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u8

Get the underlying bits value.

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

pub const fn from_bits(bits: u8) -> Option<Self>

Convert from a bits value.

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

pub const fn from_bits_truncate(bits: u8) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u8) -> Self

Convert from a bits value exactly.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub const fn complement(self) -> Self

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

impl AttributeFlags

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

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

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 AttributeFlags

pub const fn is_repeatable(&self) -> bool

Checks if the IS_REPEATABLE flag is set, meaning the attribute can be declared multiple times on the same target.

pub const fn targets_class(&self) -> bool

Checks if the TARGET_CLASS flag is set, indicating the attribute can be applied to classes, interfaces, traits, or enums.

pub const fn targets_function(&self) -> bool

Checks if the TARGET_FUNCTION flag is set, indicating the attribute can be applied to functions or closures.

pub const fn targets_method(&self) -> bool

Checks if the TARGET_METHOD flag is set, indicating the attribute can be applied to class or interface methods.

pub const fn targets_property(&self) -> bool

Checks if the TARGET_PROPERTY flag is set, indicating the attribute can be applied to class properties.

pub const fn targets_class_constant(&self) -> bool

Checks if the TARGET_CLASS_CONSTANT flag is set, indicating the attribute can be applied to class constants.

pub const fn targets_parameter(&self) -> bool

Checks if the TARGET_PARAMETER flag is set, indicating the attribute can be applied to function or method parameters.

pub const fn targets_constant(&self) -> bool

Checks if the TARGET_CONSTANT flag is set, indicating the attribute can be applied to global constants.

pub fn get_target_names(&self) -> Vec<&'static str>

Returns a list of human-readable strings for each target flag set.

Trait Implementations

impl Binary for AttributeFlags

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

Formats the value using the given formatter.

impl BitAnd for AttributeFlags

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

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

type Output = AttributeFlags

The resulting type after applying the & operator.

impl BitAndAssign for AttributeFlags

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for AttributeFlags

fn bitor(self, other: AttributeFlags) -> Self

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

type Output = AttributeFlags

The resulting type after applying the | operator.

impl BitOrAssign for AttributeFlags

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for AttributeFlags

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

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

type Output = AttributeFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for AttributeFlags

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for AttributeFlags

fn clone(&self) -> AttributeFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AttributeFlags

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AttributeFlags

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<AttributeFlags> for AttributeFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

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 AttributeFlags

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

The set of defined flags.

type Bits = u8

The underlying bits type.

fn bits(&self) -> u8

Get the underlying bits value.

fn from_bits_retain(bits: u8) -> AttributeFlags

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

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

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

impl IntoIterator for AttributeFlags

type Item = AttributeFlags

The type of the elements being iterated over.

type IntoIter = Iter<AttributeFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for AttributeFlags

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

Formats the value using the given formatter.

impl Not for AttributeFlags

fn not(self) -> Self

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

type Output = AttributeFlags

The resulting type after applying the ! operator.

impl Octal for AttributeFlags

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

Formats the value using the given formatter.

impl PartialEq for AttributeFlags

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

type Primitive = u8

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Serialize for AttributeFlags

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for AttributeFlags

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

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

The resulting type after applying the - operator.

impl SubAssign for AttributeFlags

fn sub_assign(&mut self, other: Self)

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 AttributeFlags

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

Formats the value using the given formatter.

impl Copy for AttributeFlags

impl Eq for AttributeFlags

impl StructuralPartialEq for AttributeFlags