Struct sphinx::runtime::function::Signature

pub struct Signature { /* private fields */ }

Implementations

impl Signature

pub fn new(
    name: Option<impl Into<StringSymbol>>,
    required: Vec<Parameter>,
    default: Vec<Parameter>,
    variadic: Option<Parameter>
) -> Self

pub fn name(&self) -> Option<StringSymbol>

pub fn display_short(&self) -> impl Display + '_

pub fn required(&self) -> &[Parameter]

pub fn default(&self) -> &[Parameter]

pub fn variadic(&self) -> Option<&Parameter>

pub fn min_arity(&self) -> usize

pub fn max_arity(&self) -> Option<usize>

pub fn check_args(&self, args: &[Variant]) -> ExecResult<()>

pub fn arg_len(&self) -> usize

Get the length of the argument buffer required by bind_args()

pub fn bind_args<'a>(
    &self,
    args: &'a [Variant],
    defaults: &'a [Variant],
    argbuf: &'a mut [Variant]
) -> BoundArgs<'a>

Helper for native functions. Prepares a complete argument buffer by cloning argument values, while handling default and variadic arguments. Assumes check_args() has already succeeded.

Trait Implementations

impl Clone for Signature

fn clone(&self) -> Signature

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Signature

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

Formats the value using the given formatter.

impl Display for Signature

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

Formats the value using the given formatter.