Struct BindingPattern 

#[repr(C)]
pub struct BindingPattern<'a> {
    pub kind: BindingPatternKind<'a>,
    pub type_annotation: Option<Box<'a, TSTypeAnnotation<'a>>>,
    pub optional: bool,
}

Destructuring Binding Patterns. https://tc39.es/ecma262/#prod-BindingPattern

Binding patterns can be nested within other binding patterns e.g. const [ { a: [ {x} ] } ] = arr;.

Type annotations are valid in some positions e.g. const x: T = f(); but invalid in others e.g. const [x: T] = f();.

Fields

kind: BindingPatternKind<'a>

type_annotation: Option<Box<'a, TSTypeAnnotation<'a>>>

optional: bool

Implementations

impl<'a> BindingPattern<'a>

pub fn get_identifier_name(&self) -> Option<Atom<'a>>

Returns the name of the bound identifier in this binding pattern, if it has one, or None otherwise.

Example

• calling on a = 1 in let a = 1 would return Some("a")
• calling on a = 1 in let {a = 1} = c would return Some("a")
• calling on a: b in let {a: b} = c would return None

pub fn get_binding_identifier(&self) -> Option<&BindingIdentifier<'a>>

Returns the bound identifier in this binding pattern, if it has one, or None otherwise.

To just get the name of the bound identifier, use BindingPattern::get_identifier_name.

Example

• calling on a = 1 in let a = 1 would return Some(BindingIdentifier { name: "a", .. })
• calling on a = 1 in let {a = 1} = c would return Some(BindingIdentifier { name: "a", .. })
• calling on a: b in let {a: b} = c would return None

pub fn get_binding_identifiers(&self) -> Vec<&BindingIdentifier<'a>>

Returns the bound identifiers in this binding pattern.

Example

• let {} = obj would return []
• let {a, b} = obj would return [a, b]
• let {a = 1, b: c} = obj would return [a, c]

Trait Implementations

impl<'a> BoundNames<'a> for BindingPattern<'a>

fn bound_names<F>(&self, f: &mut F)

where F: FnMut(&BindingIdentifier<'a>),

impl<'new_alloc> CloneIn<'new_alloc> for BindingPattern<'_>

type Cloned = BindingPattern<'new_alloc>

The type of the cloned object.

fn clone_in( &self, allocator: &'new_alloc Allocator, ) -> <BindingPattern<'_> as CloneIn<'new_alloc>>::Cloned

Clone self into the given allocator. allocator may be the same one that self is already in.

fn clone_in_with_semantic_ids( &self, allocator: &'new_alloc Allocator, ) -> <BindingPattern<'_> as CloneIn<'new_alloc>>::Cloned

Almost identical as clone_in, but for some special type, it will also clone the semantic ids. Please use this method only if you make sure semantic info is synced with the ast node.

impl ContentEq for BindingPattern<'_>

fn content_eq(&self, other: &BindingPattern<'_>) -> bool

This method tests for contents of self and other to be equal.

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

This method tests for contents of self and other not to be equal. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Debug for BindingPattern<'a>

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

Formats the value using the given formatter.

impl<'a> Dummy<'a> for BindingPattern<'a>

fn dummy(allocator: &'a Allocator) -> BindingPattern<'a>

Create a dummy BindingPattern.

Has cost of making 1 allocation (32 bytes).

impl<'a> GatherNodeParts<'a> for BindingPattern<'a>

fn gather<F>(&self, f: &mut F)

where F: FnMut(&str),

impl Gen for BindingPattern<'_>

fn gen(&self, p: &mut Codegen<'_>, ctx: Context)

Generate code for an AST node.

fn print(&self, p: &mut Codegen<'_>, ctx: Context)

Generate code for an AST node. Alias for gen.

impl GetSpan for BindingPattern<'_>

fn span(&self) -> Span

Get the Span for an AST node.

impl GetSpanMut for BindingPattern<'_>

fn span_mut(&mut self) -> &mut Span

Get a mutable reference to an AST node’s Span.

impl<'a> MayHaveSideEffects<'a> for BindingPattern<'a>

fn may_have_side_effects( &self, ctx: &impl MayHaveSideEffectsContext<'a>, ) -> bool

impl<'a> TakeIn<'a> for BindingPattern<'a>

fn take_in<A>(&mut self, allocator_accessor: A) -> Self

where A: AllocatorAccessor<'a>,

Replace node with a dummy.

fn take_in_box<A>(&mut self, allocator_accessor: A) -> Box<'a, Self>

where A: AllocatorAccessor<'a>,

Replace node with a boxed dummy.

impl UnstableAddress for BindingPattern<'_>

fn unstable_address(&self) -> Address

Get the memory Address of a reference to an AST node in arena, which is not necessarily stable.