Struct hotdrink_rs::builders::method_builder::MethodBuilder

pub struct MethodBuilder<T> { /* fields omitted */ }

A builder for making programmatic construction of methods easier.

Implementations

impl<T> MethodBuilder<T>

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

Constructs a new MethodBuilder.

pub fn input<S: Into<String>>(self, input: S) -> Self

Add an immutable input to the method.

pub fn input_mut<S: Into<String>>(self, input: S) -> Self

Add a mutable input to the method.

pub fn inputs(self, inputs: Vec<MethodInput>) -> Self

Set the inputs of the method.

pub fn outputs(self, outputs: Vec<MethodOutput>) -> Self

Set the outputs of the method.

pub fn apply(
    self,
    apply: impl for<'a> Fn(Vec<MethodArg<'a, T>>) -> MethodResult<T> + 'static
) -> Self

Set the function to run when this method is applied. This function takes a slice with a length corresponding to its inputs as input, and should return a vector of length corresponding to its outputs.

pub fn pure(self, pure: bool) -> Self

Set whether this method is pure (referentially transparent) or not.

This can affect optimization of the method. If it is pure and none of its inputs have changed, it will not be re-run during the next update-call. If it is not pure, it will be re-run every update. Set this to false if the method reads from or writes to something other than its inputs and outputs.

Trait Implementations

impl<T: Clone> Clone for MethodBuilder<T>

fn clone(&self) -> MethodBuilder<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for MethodBuilder<T>

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

Formats the value using the given formatter.

impl<T> Eq for MethodBuilder<T>

impl<T> PartialEq<MethodBuilder<T>> for MethodBuilder<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.