Struct arithmetic_typing::FunctionBuilder

pub struct FunctionBuilder<Prim: PrimitiveType = Num> { /* private fields */ }

Builder for functional types.

Tip. You may also use FromStr implementation to parse functional types.

Examples

Signature for a function summing a slice of numbers:

let sum_fn_type = Function::builder()
    .with_arg(Type::NUM.repeat(UnknownLen::param(0)))
    .returning(Type::NUM);
assert_eq!(sum_fn_type.to_string(), "([Num; N]) -> Num");

Signature for a slice mapping function:

// Definition of the mapping arg.
let map_fn_arg = <Function>::builder()
    .with_arg(Type::param(0))
    .returning(Type::param(1));

let map_fn_type = <Function>::builder()
    .with_arg(Type::param(0).repeat(UnknownLen::param(0)))
    .with_arg(map_fn_arg)
    .returning(Type::param(1).repeat(UnknownLen::Dynamic))
    .with_constraints(&[1], Linearity);
assert_eq!(
    map_fn_type.to_string(),
    "for<'U: Lin> (['T; N], ('T) -> 'U) -> ['U]"
);

Signature of a function with varargs:

let fn_type = <Function>::builder()
    .with_varargs(Type::param(0), UnknownLen::param(0))
    .with_arg(Type::BOOL)
    .returning(Type::param(0));
assert_eq!(fn_type.to_string(), "(...['T; N], Bool) -> 'T");

Implementations

impl<Prim: PrimitiveType> FunctionBuilder<Prim>

pub fn with_arg(self, arg: impl Into<Type<Prim>>) -> Self

Adds a new argument to the function definition.

pub fn with_varargs( self, element: impl Into<Type<Prim>>, len: impl Into<TupleLen>, ) -> Self

Adds or sets varargs in the function definition.

pub fn returning(self, return_type: impl Into<Type<Prim>>) -> Function<Prim>

Declares the return type of the function and builds it.

Trait Implementations

impl<Prim: Clone + PrimitiveType> Clone for FunctionBuilder<Prim>

fn clone(&self) -> FunctionBuilder<Prim>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Prim: Debug + PrimitiveType> Debug for FunctionBuilder<Prim>

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

Formats the value using the given formatter.

impl<Prim: PrimitiveType> Default for FunctionBuilder<Prim>

fn default() -> Self

Returns the “default value” for a type.