Enum BindingPatternKind 

#[repr(C, u8)]
pub enum BindingPatternKind<'a> {
    BindingIdentifier(Box<'a, BindingIdentifier<'a>>),
    ObjectPattern(Box<'a, ObjectPattern<'a>>),
    ArrayPattern(Box<'a, ArrayPattern<'a>>),
    AssignmentPattern(Box<'a, AssignmentPattern<'a>>),
}

Variants

BindingIdentifier(Box<'a, BindingIdentifier<'a>>)

x in const x = 1;.

Also e.g. x in:

• const [x] = arr;
• const { a: x } = obj;
• const [ ...x ] = arr;
• const [x = 1] = arr;
• function f(x) {}
• try {} catch (x) {}

ObjectPattern(Box<'a, ObjectPattern<'a>>)

{x} in const {x} = 1;.

Also e.g. {x} in:

• const [{x}] = arr;
• const { a: {x} } = obj;
• const [{x} = obj] = arr;
• const [ ...{x} ] = arr;
• function f({x}) {}
• try {} catch ({x}) {}

ArrayPattern(Box<'a, ArrayPattern<'a>>)

[x] in const [x] = 1;

Also e.g. [x] in:

• const { a: [x] } = obj;
• const { a: [x] = arr } = obj;
• const [[x]] = obj;
• const [ ...[x] ] = arr;
• function f([x]) {}
• try {} catch ([x]) {}

AssignmentPattern(Box<'a, AssignmentPattern<'a>>)

x = 1 in const {x = 1} = obj;.

Also e.g. x = 1 in:

• const [x = 1] = arr;
• const { a: x = 1 } = obj;
• function f(x = 1) {}

Also e.g. {x} = obj in:

• const [{x} = obj] = arr;
• const { a: {x} = obj2 } = obj;
• function f({x} = obj) {}

Invalid in:

• BindingRestElement e.g. const [...x = 1] = arr;.
• CatchParameter e.g. try {} catch (e = 1) {}.

Implementations

impl<'a> BindingPatternKind<'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 BindingPatternKind::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]

pub fn is_destructuring_pattern(&self) -> bool

Returns true if this binding pattern is destructuring.

Example

• {a, b} in let {a, b} = obj would return true
• [a, b] in let [a, b] = arr would return true
• a = 1 in let {a = 1} = obj would return true
• a in let {a = 1} = obj would return false

pub fn is_binding_identifier(&self) -> bool

Returns true if this binding pattern is a binding identifier like a in let a = 1.

pub fn is_object_pattern(&self) -> bool

Returns true if this binding pattern is an object pattern like {a} in let {a} = obj.

pub fn is_array_pattern(&self) -> bool

Returns true if this binding pattern is an array pattern like [a] in let [a] = arr.

pub fn is_assignment_pattern(&self) -> bool

Returns true if this binding pattern is an assignment pattern like a = 1 in let {a = 1} = obj.

Trait Implementations

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

type Cloned = BindingPatternKind<'new_alloc>

The type of the cloned object.

fn clone_in( &self, allocator: &'new_alloc Allocator, ) -> <BindingPatternKind<'_> 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, ) -> <BindingPatternKind<'_> 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 BindingPatternKind<'_>

fn content_eq(&self, other: &BindingPatternKind<'_>) -> 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 BindingPatternKind<'a>

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

Formats the value using the given formatter.

impl<'a> Dummy<'a> for BindingPatternKind<'a>

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

Create a dummy BindingPatternKind.

Has cost of making 1 allocation (32 bytes).

impl Gen for BindingPatternKind<'_>

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 GetAddress for BindingPatternKind<'_>

fn address(&self) -> Address

Get the memory address of a value allocated in the arena.

impl GetSpan for BindingPatternKind<'_>

fn span(&self) -> Span

Get the Span for an AST node.

impl GetSpanMut for BindingPatternKind<'_>

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

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

impl<'a> TakeIn<'a> for BindingPatternKind<'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.