Struct SymbolRefFlags 

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

Implementations

impl SymbolRefFlags

pub const IsNotReassigned: Self

pub const PureAnnotationOnly: Self

The function is side-effect-free solely because of a @__NO_SIDE_EFFECTS__ annotation, NOT because its body is empty. Such functions may still use their arguments, so dynamic imports inside callback arguments should not be treated as unreachable.

pub const MustStartWithCapitalLetterForJSX: Self

pub const SideEffectsFreeFunction: Self

If the SymbolRef points to a side-effects-free function

pub const HasComputedMemberWrite: Self

This symbol (a CJS default/namespace import) has a member expression write where the specific property cannot be statically determined (e.g. cjs[name] = value) or where the write goes through the namespace default (e.g. ns.default.a = value). All CJS exports of the target module should not be inlined as constants.

pub const IsFacade: Self

A “facade symbol” is a synthetic symbol created by the bundler that does not correspond to any identifier written by the user in the original source.

The bundler creates these to represent module-level concepts that need a symbol for linking and code generation, but have no declaration in the AST.

Examples:

• namespace_object_ref: represents a module’s namespace object (e.g. when you write import * as ns from './foo', ns refers to foo’s namespace object — the bundler creates a facade symbol in foo’s scope to represent that namespace)
• default_export_ref: represents a module’s default export binding when no explicit name exists (e.g. export default 42 has no declared identifier, so the bundler creates one)

pub const UsedAsJSXMemberExprRoot: Self

Root identifier of a JSX member expression (e.g. obj in <obj.Foo>). Unlike MustStartWithCapitalLetterForJSX, this only triggers uppercasing for facade (generated) symbols — user-defined names are left unchanged because <obj.Foo> is already a valid component reference in JSX.

pub const NeverReadsThis: Self

A binding that always holds a top-level function that never reads this, so calling it as a namespace member cannot observe the namespace.

impl SymbolRefFlags

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

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

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

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 SymbolRefFlags

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

Formats the value using the given formatter.

impl BitAnd for SymbolRefFlags

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

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

type Output = SymbolRefFlags

The resulting type after applying the & operator.

impl BitAndAssign for SymbolRefFlags

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for SymbolRefFlags

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

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

type Output = SymbolRefFlags

The resulting type after applying the | operator.

impl BitOrAssign for SymbolRefFlags

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for SymbolRefFlags

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

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

type Output = SymbolRefFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for SymbolRefFlags

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for SymbolRefFlags

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SymbolRefFlags

impl Debug for SymbolRefFlags

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

Formats the value using the given formatter.

impl Default for SymbolRefFlags

fn default() -> Self

Returns the “default value” for a type.

impl Extend<SymbolRefFlags> for SymbolRefFlags

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

🔬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 SymbolRefFlags

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

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

Convert from a bits value exactly.

fn all_named() -> SymbolRefFlags

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

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

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

impl IntoIterator for SymbolRefFlags

type Item = SymbolRefFlags

The type of the elements being iterated over.

type IntoIter = Iter<SymbolRefFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for SymbolRefFlags

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

Formats the value using the given formatter.

impl Not for SymbolRefFlags

fn not(self) -> Self

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

type Output = SymbolRefFlags

The resulting type after applying the ! operator.

impl Octal for SymbolRefFlags

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

Formats the value using the given formatter.

impl PublicFlags for SymbolRefFlags

type Primitive = u8

The type of the underlying storage.

type Internal = InternalBitFlags

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

impl Sub for SymbolRefFlags

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

The resulting type after applying the - operator.

impl SubAssign for SymbolRefFlags

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 SymbolRefFlags

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

Formats the value using the given formatter.