Struct SimpleFixedRule

pub struct SimpleFixedRule { /* private fields */ }

Simple wrapper for custom fixed rule. You have less control than implementing FixedRule directly, but implementation is simpler.

Implementations

impl SimpleFixedRule

pub fn new<R>(return_arity: usize, rule: R) -> Self

where R: Fn(Vec<NamedRows>, BTreeMap<String, DataValue>) -> Result<NamedRows> + Send + Sync + 'static,

Construct a SimpleFixedRule.

• return_arity: The return arity of this rule.
• rule: The rule implementation as a closure.

pub fn rule_with_channel( return_arity: usize, ) -> (Self, Receiver<(Vec<NamedRows>, BTreeMap<String, DataValue>, Sender<Result<NamedRows>>)>)

Construct a SimpleFixedRule that uses channels for communication.

Trait Implementations

impl FixedRule for SimpleFixedRule

fn arity( &self, _options: &BTreeMap<SmartString<LazyCompact>, Expr>, _rule_head: &[Symbol], _span: SourceSpan, ) -> Result<usize>

You must return the row width of the returned relation and it must be accurate. This function may be called multiple times.

fn run( &self, payload: FixedRulePayload<'_, '_>, out: &mut RegularTempStore, _poison: Poison, ) -> Result<()>

You should implement the logic of your algorithm/utility in this function. The outputs are written to out. You should check poison periodically for user-initiated termination.

fn init_options( &self, _options: &mut BTreeMap<SmartString<LazyCompact>, Expr>, _span: SourceSpan, ) -> Result<()>

Called to initialize the options given. Will always be called once, before anything else. You can mutate the options if you need to. The default implementation does nothing.