Struct TypingEngine

pub struct TypingEngine { /* private fields */ }

The main engine of typing game.

Implementations

impl TypingEngine

pub fn new() -> Self

Construct an empty engine.

This method only do construct typing engine, so you must call init method to construct query and start method to start typing.

pub fn init(&mut self, query_request: QueryRequest<'_>)

Initialize TypingEngine by constructing and resetting query using QueryRequest.

pub fn append_query( &mut self, query_request: QueryRequest<'_>, ) -> Result<(), TypingEngineError>

Append query using QueryRequest.

If this method is called before initializing via calling init method, this method returns error.

pub fn start(&mut self) -> Result<(), TypingEngineError>

Start typing.

If this method is called before initializing via calling init method, this method returns error.

pub fn stroke_key( &mut self, key_stroke: KeyStrokeChar, ) -> Result<bool, TypingEngineError>

Give a key stroke to TypingEngine.

If this method is called before initializing via calling start method, this method returns error.

pub fn stroke_key_with_elapsed_time( &mut self, key_stroke: KeyStrokeChar, elapsed_time: Duration, ) -> Result<bool, TypingEngineError>

Give a key stroke to TypingEngine with a specified elapsed time.

This method is similar to stroke_key, but it allows specifying the elapsed time.

pub fn construct_display_info( &self, lap_request: LapRequest, ) -> Result<DisplayInfo, TypingEngineError>

Construct DisplayInfo for composing UI.

If this method is called before starting via calling start method, this method returns error.

pub fn construct_result( &self, lap_request: LapRequest, ) -> Result<TypingResult, TypingEngineError>

Construct TypingResult. This method must be called when typing is finished.

Trait Implementations

impl Clone for TypingEngine

fn clone(&self) -> TypingEngine

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TypingEngine

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

Formats the value using the given formatter.

impl Default for TypingEngine

fn default() -> Self

Returns the “default value” for a type.

impl Hash for TypingEngine

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TypingEngine

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TypingEngine

impl StructuralPartialEq for TypingEngine