Struct Function 

pub struct Function {
    pub name: String,
    pub return_type: Option<String>,
    pub arguments: Vec<Argument>,
    pub description: Option<Description>,
}

Represents a parsed function type.

Fields

name: String

return_type: Option<String>

arguments: Vec<Argument>

description: Option<Description>

Implementations

impl Function

pub fn new<S: Into<String>>(name: S) -> Self

Creates a new Function instance.

Example

use thinlinelib::analysis::Function;

let function = Function::new("testFunction");

assert_eq!(function.name, String::from("testFunction"));
assert!(function.return_type.is_none());
assert!(function.arguments.is_empty());
assert!(function.description.is_none());

pub fn set_return_type(&mut self, ftype: &str) -> Fallible<()>

Creates the format type for the Function.

Example

use thinlinelib::analysis::Function;

let mut function = Function::new("testFunction");
function.set_return_type("int");

assert_eq!(function.return_type, Some(String::from("int")));

function.set_return_type("");

assert_eq!(function.return_type, None);

pub fn set_description(&mut self, description: &str)

Sets the description for the Function.

Example

use thinlinelib::analysis::Function;

let mut function = Function::new("testFunction");
function.set_description("
   int test_no = 2;
   #EQ[TL_FCT(no1: test_no, no2: 5) => 7]
   #EQ[TL_FCT(no1: 5, no2: 2) => 7]
   EXPECT_EQ(11, test_int_no1(9, 2));
");

assert!(function.description.is_some());

pub fn set_arguments(&mut self, arguments: &[Argument])

Sets arguments for the Function.

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl Default for Function

fn default() -> Function

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Function

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EntityConversion for Function

fn convert(entity_type: &mut EntityType) -> Option<&mut Function>

impl PartialEq for Function

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

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 Function