Struct Func

pub struct Func<'a> {
    pub func: &'a str,
    pub script: Script<'a>,
    /* private fields */
}

A full function that has complicated arguments and attached scripts

Fields

func: &'a str

The function name

script: Script<'a>

Any script modifications of the function

Implementations

impl<'a> Func<'a>

pub fn new<Arg>(func: &'a str, script: Script<'a>, arg: Arg) -> Self

where Arg: Into<ScriptFunc<'a>>,

Create a new function with all attached parts

pub fn without_scripts<Arg>(func: &'a str, arg: Arg) -> Self

where Arg: Into<ScriptFunc<'a>>,

Create a new function without scripts

pub fn with_sub<Sub, Arg>(func: &'a str, sub: Sub, arg: Arg) -> Self

where Sub: Into<Simple<'a>>, Arg: Into<ScriptFunc<'a>>,

Create a new function with subscripts

pub fn with_super<Sup, Arg>(func: &'a str, sup: Sup, arg: Arg) -> Self

where Sup: Into<Simple<'a>>, Arg: Into<ScriptFunc<'a>>,

Create a new function with superscripts

pub fn with_subsuper<Sub, Sup, Arg>( func: &'a str, sub: Sub, sup: Sup, arg: Arg, ) -> Self

where Sub: Into<Simple<'a>>, Sup: Into<Simple<'a>>, Arg: Into<ScriptFunc<'a>>,

Create a new function with sub and superscripts

pub fn arg(&self) -> &ScriptFunc<'a>

The function argument

Methods from Deref<Target = Script<'a>>

pub fn sub(&self) -> Option<&Simple<'a>>

Get the subscript

pub fn sup(&self) -> Option<&Simple<'a>>

Get the superscript

Trait Implementations

impl<'a> Clone for Func<'a>

fn clone(&self) -> Func<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Func<'a>

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

Formats the value using the given formatter.

impl<'a> From<Func<'a>> for ScriptFunc<'a>

fn from(func: Func<'a>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for Func<'a>

fn eq(&self, other: &Func<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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<'a> Deref for Func<'a>

type Target = Script<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> Eq for Func<'a>

impl<'a> StructuralPartialEq for Func<'a>