Struct gameshell::GameShell

pub struct GameShell<'a, C, R: Read, W: Write> { /* fields omitted */ }

The main virtual machine wrapper for a game shell

This wrapper consumes an input and output stream through which it writes messages.

Methods

impl<'a, C, R: Read, W: Write> GameShell<'a, C, R, W>

pub fn new(context: C, reader: R, writer: W) -> Self

Spawn a new gameshell with a given context and readers/writers

pub fn evaluator(&mut self) -> &mut Evaluator<'a, C>

Get a reference to the current evaluator

pub fn context(&self) -> &C

Get a reference to the current context

pub fn context_mut(&mut self) -> &mut C

Get a mutable reference to the current context

pub fn register(
    &mut self,
    spec: Spec<'_, 'a, Type, String, C>
) -> Result<(), RegError>

Register a command specificator to this gameshell instance

pub fn register_many(
    &mut self,
    spec: &[Spec<'_, 'a, Type, String, C>]
) -> Result<(), RegError>

Register multiple command specifications to this gameshell instance

Trait Implementations

impl<'a, C, R: Read, W: Write> IncConsumer for GameShell<'a, C, R, W>

fn consume(&mut self, output: &mut [u8]) -> Consumption

Consume bytes and place them on an output stack

fn validate(&mut self, input: u8) -> Validation

Validate part of the bytestream, as soon as we return Validation::Ready, process will be run on the current accumulated bytes, after which these bytes will be deleted.

fn process(&mut self, input: &[u8]) -> Process

Process do actual stuff with the bytes to affect the system.

fn run(&mut self, buf: &mut [u8])

Runs the incremental consumer until it is signalled to quit