Struct BindingFlags 

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

Flags on a Binding.

Implementations

impl BindingFlags

pub const EXPLICIT_EXPORT: Self

The binding represents an explicit re-export.

For example, the binding could be FastAPI in:

from fastapi import FastAPI as FastAPI

pub const EXTERNAL: Self

The binding represents an external symbol, like an import or a builtin.

For example, the binding could be FastAPI in:

from fastapi import FastAPI

pub const ALIAS: Self

The binding is an aliased symbol.

For example, the binding could be app in:

from fastapi import FastAPI as app

pub const NONLOCAL: Self

The binding is nonlocal to the declaring scope. This could be a binding created by a nonlocal statement, or a binding that shadows such a binding.

For example, both of the bindings in the following function are nonlocal:

def f():
    nonlocal x
    x = 1

pub const GLOBAL: Self

The binding is global. This could be a binding created by a global statement, or a binding that shadows such a binding.

For example, both of the bindings in the following function are global:

def f():
    global x
    x = 1

pub const DELETED: Self

The binding was deleted (i.e., the target of a del statement).

For example, the binding could be x in:

del x

The semantic model will typically shadow a deleted binding via an additional binding with BindingKind::Deletion; however, conditional deletions (e.g., if condition: del x) do not generate a shadow binding. This flag is thus used to detect whether a binding was ever deleted, even conditionally.

pub const INVALID_ALL_FORMAT: Self

The binding represents an export via __all__, but the assigned value uses an invalid expression (i.e., a non-container type).

For example:

__all__ = 1

pub const INVALID_ALL_OBJECT: Self

The binding represents an export via __all__, but the assigned value contains an invalid member (i.e., a non-string).

For example:

__all__ = [1]

pub const PRIVATE_DECLARATION: Self

The binding represents a private declaration.

For example, the binding could be _T in:

_T = "This is a private variable"

pub const UNPACKED_ASSIGNMENT: Self

The binding represents an unpacked assignment.

For example, the binding could be x in:

(x, y) = 1, 2

pub const IN_EXCEPT_HANDLER: Self

The binding took place inside an exception handling.

For example, the x binding in the following example would not have this flag set, but the y binding would:

try:
    x = 42
except RuntimeError:
    y = 42

pub const ANNOTATED_TYPE_ALIAS: Self

The binding represents a PEP 613 explicit type alias.

pub const DEFERRED_TYPE_ALIAS: Self

The binding represents a PEP 695 type statement

pub const IN_ASSERT_STATEMENT: Self

The binding took place inside an assert statement

For example, x in the following snippet:

assert (x := y**2) > 42, x

pub const TYPE_ALIAS: Self

The binding represents any type alias.

impl BindingFlags

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

Convert from a bits value.

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

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

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u16) -> 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 self 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 other are also set in self.

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

Whether all set bits in other are also set in self.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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 self and other.

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 self and other.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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 self and other.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl BindingFlags

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

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

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.

Trait Implementations

impl Binary for BindingFlags

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

Formats the value using the given formatter.

impl BitAnd for BindingFlags

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

The bitwise and (&) of the bits in self and other.

type Output = BindingFlags

The resulting type after applying the & operator.

impl BitAndAssign for BindingFlags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in self and other.

impl BitOr for BindingFlags

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

The bitwise or (|) of the bits in self and other.

type Output = BindingFlags

The resulting type after applying the | operator.

impl BitOrAssign for BindingFlags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in self and other.

impl BitXor for BindingFlags

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

The bitwise exclusive-or (^) of the bits in self and other.

type Output = BindingFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for BindingFlags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in self and other.

impl Clone for BindingFlags

fn clone(&self) -> BindingFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BindingFlags

impl Debug for BindingFlags

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

Formats the value using the given formatter.

impl Default for BindingFlags

fn default() -> BindingFlags

Returns the “default value” for a type.

impl Eq for BindingFlags

impl Extend<BindingFlags> for BindingFlags

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 BindingFlags

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

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

Convert from a bits value exactly.

fn all_named() -> BindingFlags

Get a flags value with all bits from named flags set.

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 iter_equal_names(&self) -> IterEqualNames<Self>

Get an iterator over all defined names for this flags value.

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 other are also set in self.

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

where Self: Sized,

Whether all set bits in other are also set in self.

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 self and other.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of self with the complement of other (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in self and other.

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 self and other.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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

The bitwise exclusive-or (^) of the bits in self and other.

fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl FromIterator<BindingFlags> for BindingFlags

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

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

impl IntoIterator for BindingFlags

type Item = BindingFlags

The type of the elements being iterated over.

type IntoIter = Iter<BindingFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for BindingFlags

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

Formats the value using the given formatter.

impl Not for BindingFlags

fn not(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

type Output = BindingFlags

The resulting type after applying the ! operator.

impl Octal for BindingFlags

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

Formats the value using the given formatter.

impl PartialEq for BindingFlags

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

Equality operator ==.

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

Inequality operator !=.

impl PublicFlags for BindingFlags

type Primitive = u16

The type of the underlying storage.

type Internal = InternalBitFlags

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

impl StructuralPartialEq for BindingFlags

impl Sub for BindingFlags

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

The intersection of self with the complement of other (&!).

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

The resulting type after applying the - operator.

impl SubAssign for BindingFlags

fn sub_assign(&mut self, other: Self)

The intersection of self with the complement of other (&!).

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 BindingFlags

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

Formats the value using the given formatter.