Struct RubyFunction

pub struct RubyFunction {
    pub name: String,
    pub lines: (usize, usize),
    pub class: Vec<RubyClass>,
    pub args: RubyParams,
    pub body: String,
}

Fields

name: String

lines: (usize, usize)

class: Vec<RubyClass>

args: RubyParams

body: String

Implementations

impl RubyFunction

pub const fn new( name: String, lines: (usize, usize), class: Vec<RubyClass>, args: RubyParams, body: String, ) -> Self

creates a new RubyFunction

Trait Implementations

impl Clone for RubyFunction

fn clone(&self) -> RubyFunction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RubyFunction

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

Formats the value using the given formatter.

impl Display for RubyFunction

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

don’t use this for anything other than debugging the output is not guaranteed to be in the right order use fmt::Display for RubyFile instead

impl FunctionTrait for RubyFunction

fn get_lines(&self) -> (usize, usize)

returns the starting and ending line of the function

fn get_name(&self) -> String

returns the name of the function

fn get_body(&self) -> String

returns the body of the function (the whole function including its signature and end)

fn get_total_lines(&self) -> (usize, usize)

returns the starting and ending line of the the function including any class/impls (among others) the function is part of

fn get_tops(&self) -> Vec<(String, usize)>

returns the tops like any the heading of classes/impls (among others) the function is part of along with the starting line of each heading for example it could return [("impl Test {", 3)] to get just for example the headings use the map method function.get_tops().map(|top| top.0)

fn get_bottoms(&self) -> Vec<(String, usize)>

same as get_tops just retrieves the bottoms like so [("}", 22)]

impl PartialEq for RubyFunction

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

impl StructuralPartialEq for RubyFunction