Enum AssignmentTarget 

#[repr(C, u8)]
pub enum AssignmentTarget<'a> {
    AssignmentTargetIdentifier(Box<'a, IdentifierReference<'a>>),
    TSAsExpression(Box<'a, TSAsExpression<'a>>),
    TSSatisfiesExpression(Box<'a, TSSatisfiesExpression<'a>>),
    TSNonNullExpression(Box<'a, TSNonNullExpression<'a>>),
    TSTypeAssertion(Box<'a, TSTypeAssertion<'a>>),
    ComputedMemberExpression(Box<'a, ComputedMemberExpression<'a>>),
    StaticMemberExpression(Box<'a, StaticMemberExpression<'a>>),
    PrivateFieldExpression(Box<'a, PrivateFieldExpression<'a>>),
    ArrayAssignmentTarget(Box<'a, ArrayAssignmentTarget<'a>>),
    ObjectAssignmentTarget(Box<'a, ObjectAssignmentTarget<'a>>),
}

Destructuring Assignment

Inherits variants from SimpleAssignmentTarget and AssignmentTargetPattern. See ast module docs for explanation of inheritance.

Variants

AssignmentTargetIdentifier(Box<'a, IdentifierReference<'a>>)

Inherited from SimpleAssignmentTarget

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

Inherited from SimpleAssignmentTarget

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

Inherited from SimpleAssignmentTarget

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

Inherited from SimpleAssignmentTarget

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

Inherited from SimpleAssignmentTarget

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

Inherited from SimpleAssignmentTarget

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

Inherited from SimpleAssignmentTarget

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

Inherited from SimpleAssignmentTarget

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

Inherited from AssignmentTargetPattern

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

Inherited from AssignmentTargetPattern

Implementations

impl<'a> AssignmentTarget<'a>

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

Returns the identifier name of this assignment target when it is simple like a = b.

Example

• returns a when called on the left-hand side of a = b
• returns b when called on the left-hand side of a.b = b
• returns None when called on the left-hand side of a[b] = b

pub fn get_expression(&self) -> Option<&Expression<'a>>

Returns the expression inside of this assignment target, if applicable, and returns a reference to it.

For getting a mutable reference of the expression inside, use AssignmentTarget::get_expression_mut.

Example

• returns a when called on a! in a! = b
• returns None when called on a in a = b because there is no inner expression to get

pub fn get_expression_mut(&mut self) -> Option<&mut Expression<'a>>

Returns the expression inside of this assignment target, if applicable, and returns a mutable reference to it.

For getting an immutable reference of the expression inside, use AssignmentTarget::get_expression.

Example

• returns a when called on a! in a! = b
• returns None when called on a in a = b because there is no inner expression to get

impl<'a> AssignmentTarget<'a>

pub fn new_assignment_target_identifier<B: GetAstBuilder<'a>, S1>( span: Span, name: S1, builder: &B, ) -> Self

where S1: Into<Ident<'a>>,

Build an AssignmentTarget::AssignmentTargetIdentifier.

This node contains an IdentifierReference that will be stored in the memory arena.

Parameters

• span: The Span covering this node
• name: The name of the identifier being referenced.

pub fn new_assignment_target_identifier_with_reference_id<B: GetAstBuilder<'a>, S1>( span: Span, name: S1, reference_id: ReferenceId, builder: &B, ) -> Self

where S1: Into<Ident<'a>>,

Build an AssignmentTarget::AssignmentTargetIdentifier with reference_id.

This node contains an IdentifierReference that will be stored in the memory arena.

Parameters

• span: The Span covering this node
• name: The name of the identifier being referenced.
• reference_id: Reference ID

pub fn new_ts_as_expression<B: GetAstBuilder<'a>>( span: Span, expression: Expression<'a>, type_annotation: TSType<'a>, builder: &B, ) -> Self

Build an AssignmentTarget::TSAsExpression.

This node contains a TSAsExpression that will be stored in the memory arena.

Parameters

• span: The Span covering this node
• expression
• type_annotation

pub fn new_ts_satisfies_expression<B: GetAstBuilder<'a>>( span: Span, expression: Expression<'a>, type_annotation: TSType<'a>, builder: &B, ) -> Self

Build an AssignmentTarget::TSSatisfiesExpression.

This node contains a TSSatisfiesExpression that will be stored in the memory arena.

Parameters

• span: The Span covering this node
• expression: The value expression being constrained.
• type_annotation: The type expression must satisfy.

pub fn new_ts_non_null_expression<B: GetAstBuilder<'a>>( span: Span, expression: Expression<'a>, builder: &B, ) -> Self

Build an AssignmentTarget::TSNonNullExpression.

This node contains a TSNonNullExpression that will be stored in the memory arena.

Parameters

• span: The Span covering this node
• expression

pub fn new_ts_type_assertion<B: GetAstBuilder<'a>>( span: Span, type_annotation: TSType<'a>, expression: Expression<'a>, builder: &B, ) -> Self

Build an AssignmentTarget::TSTypeAssertion.

This node contains a TSTypeAssertion that will be stored in the memory arena.

Parameters

• span: The Span covering this node
• type_annotation
• expression

pub fn new_computed_member_expression<B: GetAstBuilder<'a>>( span: Span, object: Expression<'a>, expression: Expression<'a>, optional: bool, builder: &B, ) -> Self

Build an AssignmentTarget::ComputedMemberExpression.

This node contains a ComputedMemberExpression that will be stored in the memory arena.

Parameters

• span: The Span covering this node
• object
• expression
• optional

pub fn new_static_member_expression<B: GetAstBuilder<'a>>( span: Span, object: Expression<'a>, property: IdentifierName<'a>, optional: bool, builder: &B, ) -> Self

Build an AssignmentTarget::StaticMemberExpression.

This node contains a StaticMemberExpression that will be stored in the memory arena.

Parameters

• span: The Span covering this node
• object
• property
• optional

pub fn new_private_field_expression<B: GetAstBuilder<'a>>( span: Span, object: Expression<'a>, field: PrivateIdentifier<'a>, optional: bool, builder: &B, ) -> Self

Build an AssignmentTarget::PrivateFieldExpression.

This node contains a PrivateFieldExpression that will be stored in the memory arena.

Parameters

• span: The Span covering this node
• object
• field
• optional

pub fn new_array_assignment_target<B: GetAstBuilder<'a>, T1>( span: Span, elements: ArenaVec<'a, Option<AssignmentTargetMaybeDefault<'a>>>, rest: T1, builder: &B, ) -> Self

where T1: IntoIn<'a, Option<ArenaBox<'a, AssignmentTargetRest<'a>>>>,

Build an AssignmentTarget::ArrayAssignmentTarget.

This node contains an ArrayAssignmentTarget that will be stored in the memory arena.

Parameters

• span: The Span covering this node
• elements
• rest

pub fn new_object_assignment_target<B: GetAstBuilder<'a>, T1>( span: Span, properties: ArenaVec<'a, AssignmentTargetProperty<'a>>, rest: T1, builder: &B, ) -> Self

where T1: IntoIn<'a, Option<ArenaBox<'a, AssignmentTargetRest<'a>>>>,

Build an AssignmentTarget::ObjectAssignmentTarget.

This node contains an ObjectAssignmentTarget that will be stored in the memory arena.

Parameters

• span: The Span covering this node
• properties
• rest

impl AssignmentTarget<'_>

pub fn node_id(&self) -> NodeId

Get NodeId of AssignmentTarget.

impl<'a> AssignmentTarget<'a>

pub fn is_simple_assignment_target(&self) -> bool

Return if an AssignmentTarget is a SimpleAssignmentTarget.

pub fn into_simple_assignment_target(self) -> SimpleAssignmentTarget<'a>

Convert an AssignmentTarget to a SimpleAssignmentTarget.

Panics

Panics if not convertible.

pub fn as_simple_assignment_target(&self) -> Option<&SimpleAssignmentTarget<'a>>

Convert an &AssignmentTarget to a &SimpleAssignmentTarget.

pub fn as_simple_assignment_target_mut( &mut self, ) -> Option<&mut SimpleAssignmentTarget<'a>>

Convert an &mut AssignmentTarget to a &mut SimpleAssignmentTarget.

pub fn to_simple_assignment_target(&self) -> &SimpleAssignmentTarget<'a>

Convert an &AssignmentTarget to a &SimpleAssignmentTarget.

Panics

Panics if not convertible.

pub fn to_simple_assignment_target_mut( &mut self, ) -> &mut SimpleAssignmentTarget<'a>

Convert an &mut AssignmentTarget to a &mut SimpleAssignmentTarget.

Panics

Panics if not convertible.

impl<'a> AssignmentTarget<'a>

pub fn is_member_expression(&self) -> bool

Return if an AssignmentTarget is a MemberExpression.

pub fn into_member_expression(self) -> MemberExpression<'a>

Convert an AssignmentTarget to a MemberExpression.

Panics

Panics if not convertible.

pub fn as_member_expression(&self) -> Option<&MemberExpression<'a>>

Convert an &AssignmentTarget to a &MemberExpression.

pub fn as_member_expression_mut(&mut self) -> Option<&mut MemberExpression<'a>>

Convert an &mut AssignmentTarget to a &mut MemberExpression.

pub fn to_member_expression(&self) -> &MemberExpression<'a>

Convert an &AssignmentTarget to a &MemberExpression.

Panics

Panics if not convertible.

pub fn to_member_expression_mut(&mut self) -> &mut MemberExpression<'a>

Convert an &mut AssignmentTarget to a &mut MemberExpression.

Panics

Panics if not convertible.

impl<'a> AssignmentTarget<'a>

pub fn is_assignment_target_pattern(&self) -> bool

Return if an AssignmentTarget is an AssignmentTargetPattern.

pub fn into_assignment_target_pattern(self) -> AssignmentTargetPattern<'a>

Convert an AssignmentTarget to an AssignmentTargetPattern.

Panics

Panics if not convertible.

pub fn as_assignment_target_pattern( &self, ) -> Option<&AssignmentTargetPattern<'a>>

Convert an &AssignmentTarget to an &AssignmentTargetPattern.

pub fn as_assignment_target_pattern_mut( &mut self, ) -> Option<&mut AssignmentTargetPattern<'a>>

Convert an &mut AssignmentTarget to an &mut AssignmentTargetPattern.

pub fn to_assignment_target_pattern(&self) -> &AssignmentTargetPattern<'a>

Convert an &AssignmentTarget to an &AssignmentTargetPattern.

Panics

Panics if not convertible.

pub fn to_assignment_target_pattern_mut( &mut self, ) -> &mut AssignmentTargetPattern<'a>

Convert an &mut AssignmentTarget to an &mut AssignmentTargetPattern.

Panics

Panics if not convertible.

impl<'a> AssignmentTarget<'a>

pub fn as_assignment_target_maybe_default( &self, ) -> &AssignmentTargetMaybeDefault<'a>

Convert an &AssignmentTarget to an &AssignmentTargetMaybeDefault.

impl<'a> AssignmentTarget<'a>

pub fn as_for_statement_left(&self) -> &ForStatementLeft<'a>

Convert an &AssignmentTarget to a &ForStatementLeft.

Trait Implementations

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

type Cloned = AssignmentTarget<'new_alloc>

The type of the cloned object.

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

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

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

Formats the value using the given formatter.

impl<'a> Dummy<'a> for AssignmentTarget<'a>

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

Create a dummy AssignmentTarget.

Has cost of making 1 allocation (32 bytes).

impl<'a> From<AssignmentTarget<'a>> for AssignmentTargetMaybeDefault<'a>

fn from(value: AssignmentTarget<'a>) -> Self

Convert an AssignmentTarget to an AssignmentTargetMaybeDefault.

impl<'a> From<AssignmentTarget<'a>> for ForStatementLeft<'a>

fn from(value: AssignmentTarget<'a>) -> Self

Convert an AssignmentTarget to a ForStatementLeft.

impl<'a> From<AssignmentTargetPattern<'a>> for AssignmentTarget<'a>

fn from(value: AssignmentTargetPattern<'a>) -> Self

Convert an AssignmentTargetPattern to an AssignmentTarget.

impl<'a> From<MemberExpression<'a>> for AssignmentTarget<'a>

fn from(value: MemberExpression<'a>) -> Self

Convert a MemberExpression to an AssignmentTarget.

impl<'a> From<SimpleAssignmentTarget<'a>> for AssignmentTarget<'a>

fn from(value: SimpleAssignmentTarget<'a>) -> Self

Convert a SimpleAssignmentTarget to an AssignmentTarget.

impl GetAddress for AssignmentTarget<'_>

fn address(&self) -> Address

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

impl GetSpan for AssignmentTarget<'_>

fn span(&self) -> Span

Get the Span for an AST node.

impl GetSpanMut for AssignmentTarget<'_>

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

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

impl<'a> ReplaceWith<'a> for AssignmentTarget<'a>

fn replace_with(&mut self, replacer: impl FnOnce(Self) -> Self)

Replace the node in place with the value returned by replacer.

impl<'a> TakeIn<'a> for AssignmentTarget<'a>

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

where A: GetAllocator<'a>,

Replace node with a dummy, and return the original.

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

where A: GetAllocator<'a>,

Replace node with a dummy, allocate the original node into the arena, and return it as a Box<Self>.

impl<'a> TryFrom<AssignmentTarget<'a>> for SimpleAssignmentTarget<'a>

fn try_from(value: AssignmentTarget<'a>) -> Result<Self, Self::Error>

Convert an AssignmentTarget to a SimpleAssignmentTarget.

Errors

Returns Err if not convertible.

type Error = ()

The type returned in the event of a conversion error.

impl<'a> TryFrom<AssignmentTarget<'a>> for MemberExpression<'a>

fn try_from(value: AssignmentTarget<'a>) -> Result<Self, Self::Error>

Convert an AssignmentTarget to a MemberExpression.

Errors

Returns Err if not convertible.

type Error = ()

The type returned in the event of a conversion error.

impl<'a> TryFrom<AssignmentTarget<'a>> for AssignmentTargetPattern<'a>

fn try_from(value: AssignmentTarget<'a>) -> Result<Self, Self::Error>

Convert an AssignmentTarget to an AssignmentTargetPattern.

Errors

Returns Err if not convertible.

type Error = ()

The type returned in the event of a conversion error.

impl<'a> TryFrom<AssignmentTargetMaybeDefault<'a>> for AssignmentTarget<'a>

fn try_from( value: AssignmentTargetMaybeDefault<'a>, ) -> Result<Self, Self::Error>

Convert an AssignmentTargetMaybeDefault to an AssignmentTarget.

Errors

Returns Err if not convertible.

type Error = ()

The type returned in the event of a conversion error.

impl<'a> TryFrom<ForStatementLeft<'a>> for AssignmentTarget<'a>

fn try_from(value: ForStatementLeft<'a>) -> Result<Self, Self::Error>

Convert a ForStatementLeft to an AssignmentTarget.

Errors

Returns Err if not convertible.

type Error = ()

The type returned in the event of a conversion error.