Trait PQLFn

pub trait PQLFn:
    Debug
    + Send
    + Sync
    + PQLFnRtn
    + PQLFnArgs
    + PQLFnEval { }

Trait for functions to be used in vm

Generated by fn_macro::pqlfn Example:

#[pqlfn(arg, rtn, eval)]
pub fn hand_ranks(hand: &Hand, _street: PQLStreet) -> PQLRankSet;

pub trait PQLFnArgs {
    fn arg_types(&self) -> &[PQLType] {
        &[PQLType::Player, PQLType::Street]
    }
}

pub trait PQLFnRtn {
    fn rtn_type(&self) -> PQLType {
        PQLType::RankSet
    }
}

pub trait PQLFnEval {
    fn evaluate(
        &self,
        buffer: &mut VmBuffer,
        store: &mut VmStore,
        stack: &mut VmStack,
    ) -> Result<VmStackValue, PQLError> {
        Ok(self(arg_range(buffer, store, stack), (&*buffer).into()).into())
    }
}

each pqlfn also generates a match arm for FromStr of &dyn PQLFn

  "handranks" => Ok(&(hand_ranks as fn(&Hand, PQLStreet) -> PQLRankSet)),

Trait Implementations

impl From<&'static dyn PQLFn> for VmInstruction

fn from(value: &'static dyn PQLFn) -> Self

Converts to this type from the input type.

impl FromStr for &dyn PQLFn

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

Implementors

impl<T> PQLFn for T

where T: Debug + Send + Sync + PQLFnRtn + PQLFnArgs + PQLFnEval,