Struct LocalFunction

pub struct LocalFunction { /* private fields */ }

A declaration of a local function, such as local function x() end

Implementations

impl LocalFunction

pub fn new(name: TokenReference) -> Self

Returns a new LocalFunction from the given name

pub fn attributes(&self) -> impl Iterator<Item = &LuauAttribute>

Available on crate feature luau only.

The attributes in the function, e.g. @native

pub fn local_token(&self) -> &TokenReference

The local token

pub fn function_token(&self) -> &TokenReference

The function token

pub fn body(&self) -> &FunctionBody

The function body, everything except local function x in local function x(a, b, c) call() end

pub fn name(&self) -> &TokenReference

The name of the function, the x part of local function x() end

pub fn with_attributes(self, attributes: Vec<LuauAttribute>) -> Self

Available on crate feature luau only.

Returns a new LocalFunction with the given attributes (e.g. @native)

pub fn with_local_token(self, local_token: TokenReference) -> Self

Returns a new LocalFunction with the given local token

pub fn with_function_token(self, function_token: TokenReference) -> Self

Returns a new LocalFunction with the given function token

pub fn with_name(self, name: TokenReference) -> Self

Returns a new LocalFunction with the given name

pub fn with_body(self, body: FunctionBody) -> Self

Returns a new LocalFunction with the given function body

Trait Implementations

impl Clone for LocalFunction

fn clone(&self) -> LocalFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LocalFunction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LocalFunction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LocalFunction

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

Formats the value using the given formatter.

impl Node for LocalFunction

fn start_position(&self) -> Option<Position>

The start position of a node. None if can’t be determined

fn end_position(&self) -> Option<Position>

The end position of a node. None if it can’t be determined

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

Whether another node of the same type is the same as this one semantically, ignoring position

fn tokens<'a>(&'a self) -> Tokens<'a>

The token references that comprise a node

fn range(&self) -> Option<(Position, Position)>

The full range of a node, if it has both start and end positions

fn surrounding_trivia(&self) -> (Vec<&Token>, Vec<&Token>)

The tokens surrounding a node that are ignored and not accessible through the node’s own accessors. Use this if you want to get surrounding comments or whitespace. Returns a tuple of the leading and trailing trivia.

impl PartialEq for LocalFunction

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LocalFunction