Struct ReturnStatement 

pub struct ReturnStatement { /* private fields */ }

Represents a return statement.

Implementations

impl ReturnStatement

pub fn new(expressions: Vec<Expression>) -> Self

Creates a new return statement with the given expressions.

pub fn one<E: Into<Expression>>(expression: E) -> Self

Creates a new ReturnStatement with one expression.

let statement = ReturnStatement::one(true);

// unknown case
assert_eq!(statement.len(), 1);

pub fn with_expression<E: Into<Expression>>(self, expression: E) -> Self

Adds an expression to this return statement.

pub fn iter_expressions(&self) -> impl Iterator<Item = &Expression>

Returns an iterator over the expressions.

pub fn into_iter_expressions(self) -> impl Iterator<Item = Expression>

Converts this return statement into an iterator over its expressions.

pub fn iter_mut_expressions(&mut self) -> impl Iterator<Item = &mut Expression>

Returns a mutable iterator over the expressions.

pub fn is_empty(&self) -> bool

Returns whether this return statement has no expressions.

pub fn len(&self) -> usize

Returns the number of expressions.

pub fn with_tokens(self, tokens: ReturnTokens) -> Self

Sets the tokens for this return statement.

pub fn set_tokens(&mut self, tokens: ReturnTokens)

Sets the tokens for this return statement.

pub fn get_tokens(&self) -> Option<&ReturnTokens>

Returns the tokens for this return statement, if any.

pub fn mutate_tokens(&mut self) -> Option<&mut ReturnTokens>

Returns a mutable reference to the tokens, if any.

pub fn mutate_first_token(&mut self) -> &mut Token

Returns a mutable reference to the first token for this statement, creating it if missing.

pub fn mutate_last_token(&mut self) -> &mut Token

Returns a mutable reference to the last token for this statement, creating it if missing.

pub fn clear_comments(&mut self)

Clears all comments from the tokens in this node.

pub fn clear_whitespaces(&mut self)

Clears all whitespaces information from the tokens in this node.

Trait Implementations

impl Clone for ReturnStatement

fn clone(&self) -> ReturnStatement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReturnStatement

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

Formats the value using the given formatter.

impl Default for ReturnStatement

fn default() -> ReturnStatement

Returns the “default value” for a type.

impl From<ReturnStatement> for Block

fn from(statement: ReturnStatement) -> Block

Converts to this type from the input type.

impl From<ReturnStatement> for LastStatement

fn from(statement: ReturnStatement) -> Self

Converts to this type from the input type.

impl PartialEq for ReturnStatement

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

impl StructuralPartialEq for ReturnStatement