Struct forne::Forne

pub struct Forne { /* private fields */ }

A Forne engine, which can act as the backend for learn operations. An instance of this struct should be instantiated with a Set to operate on and an operation to perform.

The engine has the same lifetime as the reference it is given to its interface for communicating with the host environment.

Implementations

impl Forne

pub fn new_set( src: String, adapter_script: &str, raw_method: RawMethod ) -> Result<Self>

Creates a new set from the given source file text and adapter script. This is a thin wrapper over the Set::new_with_adapter method, abstracting away the internal use of a Rhai engine. In general, you should prefer this method, as there is no additional overhead to using it.

pub fn update( &mut self, src: String, adapter_script: &str, raw_method: RawMethod ) -> Result<()>

Updates the given set from a source. See Set::update_with_adapter for the exact behaviour of this method.

pub fn from_set(set: Set) -> Self

Creates a new Forne engine. While not inherently expensive, this should generally only be called once, or when the system needs to restart.

pub fn learn(&mut self, raw_method: RawMethod) -> Result<Driver<'_, '_>>

Start a new learning session with this instance and the given method (see RawMethod), creating a Driver to run it.

Errors

This will return an error if the given method has not previously been used with this set, and a reset must be performed in that case, which will lead to the loss of previous progress, unless a transformer is used.

pub fn test(&mut self) -> Driver<'_, '_>

Start a new test with this instance, creating a Driver to run it.

pub fn save_set(&self) -> Result<String>

Saves this set to JSON.

Errors

This can only possible fail if the learning method produces metadata that cannot be serialized into JSON.

pub fn reset_learn(&mut self, method: RawMethod) -> Result<()>

Resets all cards in a learn session back to the default metadata values prescribed by the learning method.

pub fn reset_test(&mut self)

Resets all test progress for this set. This is irreversible!

This will not change whether or not cards are starred.