Struct SymbolFlags 

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

Semantic analysis (scopes, symbols, references)

Implementations

impl SymbolFlags

pub const None: SymbolFlags

pub const FunctionScopedVariable: SymbolFlags

Variable (var) or parameter

pub const BlockScopedVariable: SymbolFlags

A block-scoped variable (let or const)

pub const ConstVariable: SymbolFlags

A const variable (const)

pub const Class: SymbolFlags

pub const CatchVariable: SymbolFlags

try {} catch(catch_variable) {}

pub const Function: SymbolFlags

A function declaration or expression

pub const Import: SymbolFlags

Imported ESM binding

pub const TypeImport: SymbolFlags

Imported ESM type-only binding

pub const TypeAlias: SymbolFlags

pub const Interface: SymbolFlags

pub const RegularEnum: SymbolFlags

pub const ConstEnum: SymbolFlags

pub const EnumMember: SymbolFlags

pub const TypeParameter: SymbolFlags

pub const NamespaceModule: SymbolFlags

Uninstantiated module

pub const ValueModule: SymbolFlags

Instantiated module

pub const Ambient: SymbolFlags

Declared with declare modifier, like declare function x() {}.

pub const Enum: SymbolFlags

pub const Variable: SymbolFlags

pub const BlockScoped: SymbolFlags

pub const Value: SymbolFlags

pub const Type: SymbolFlags

pub const Namespace: SymbolFlags

pub const FunctionScopedVariableExcludes: SymbolFlags

Variables can be redeclared, but can not redeclare a block-scoped declaration with the same name, or any other value that is not a variable, e.g. ValueModule or Class

pub const BlockScopedVariableExcludes: SymbolFlags

Block-scoped declarations are not allowed to be re-declared they can not merge with anything in the value space

pub const FunctionExcludes: SymbolFlags

pub const ClassExcludes: SymbolFlags

pub const ImportBindingExcludes: SymbolFlags

pub const TypeAliasExcludes: SymbolFlags

pub const InterfaceExcludes: SymbolFlags

pub const TypeParameterExcludes: SymbolFlags

pub const ConstEnumExcludes: SymbolFlags

pub const ValueModuleExcludes: SymbolFlags

pub const NamespaceModuleExcludes: SymbolFlags

pub const RegularEnumExcludes: SymbolFlags

pub const EnumMemberExcludes: SymbolFlags

impl SymbolFlags

pub const fn empty() -> SymbolFlags

Get a flags value with all bits unset.

pub const fn all() -> SymbolFlags

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

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

pub const fn from_bits(bits: u32) -> Option<SymbolFlags>

Convert from a bits value.

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

pub const fn from_bits_truncate(bits: u32) -> SymbolFlags

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> SymbolFlags

Convert from a bits value exactly.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub const fn complement(self) -> SymbolFlags

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

impl SymbolFlags

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

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

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 SymbolFlags

pub fn is_variable(self) -> bool

pub fn is_type_parameter(self) -> bool

pub fn is_type(self) -> bool

If true, then the symbol is a type, such as a TypeAlias, Interface, or Enum

pub fn is_value(self) -> bool

If true, then the symbol is a value, such as a Variable, Function, or Class

pub fn is_const_variable(self) -> bool

pub fn is_function(self) -> bool

Returns true if this symbol is a function declaration or expression.

pub fn is_class(self) -> bool

pub fn is_interface(self) -> bool

pub fn is_type_alias(self) -> bool

pub fn is_enum(self) -> bool

pub fn is_const_enum(self) -> bool

pub fn is_enum_member(self) -> bool

pub fn is_catch_variable(self) -> bool

pub fn is_function_scoped_declaration(self) -> bool

pub fn is_import(self) -> bool

pub fn is_type_import(self) -> bool

pub fn is_ambient(self) -> bool

pub fn is_namespace_module(self) -> bool

pub fn is_value_module(self) -> bool

pub fn can_be_referenced_by_type(self) -> bool

If true, then the symbol can be referenced by a type reference

pub fn can_be_referenced_by_value(self) -> bool

If true, then the symbol can be referenced by a value reference

pub fn can_be_referenced_by_value_as_type(self) -> bool

If true, then the symbol can be referenced by a value_as_type reference

Trait Implementations

impl Binary for SymbolFlags

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

Formats the value using the given formatter.

impl BitAnd for SymbolFlags

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

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

type Output = SymbolFlags

The resulting type after applying the & operator.

impl BitAndAssign for SymbolFlags

fn bitand_assign(&mut self, other: SymbolFlags)

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

impl BitOr for SymbolFlags

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

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

type Output = SymbolFlags

The resulting type after applying the | operator.

impl BitOrAssign for SymbolFlags

fn bitor_assign(&mut self, other: SymbolFlags)

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

impl BitXor for SymbolFlags

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

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

type Output = SymbolFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for SymbolFlags

fn bitxor_assign(&mut self, other: SymbolFlags)

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

impl Clone for SymbolFlags

fn clone(&self) -> SymbolFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolFlags

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

Formats the value using the given formatter.

impl Extend<SymbolFlags> for SymbolFlags

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

where T: IntoIterator<Item = SymbolFlags>,

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 SymbolFlags

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

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> SymbolFlags

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

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

where T: IntoIterator<Item = SymbolFlags>,

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

impl IntoIterator for SymbolFlags

type Item = SymbolFlags

The type of the elements being iterated over.

type IntoIter = Iter<SymbolFlags>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl LowerHex for SymbolFlags

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

Formats the value using the given formatter.

impl Not for SymbolFlags

fn not(self) -> SymbolFlags

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

type Output = SymbolFlags

The resulting type after applying the ! operator.

impl Octal for SymbolFlags

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

Formats the value using the given formatter.

impl PartialEq for SymbolFlags

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

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

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

The resulting type after applying the - operator.

impl SubAssign for SymbolFlags

fn sub_assign(&mut self, other: SymbolFlags)

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 SymbolFlags

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

Formats the value using the given formatter.

impl Copy for SymbolFlags

impl Eq for SymbolFlags

impl StructuralPartialEq for SymbolFlags