Struct ruci::UciConnection

pub struct UciConnection<MSend, MReceive>
where
    MSend: Message,
    MReceive: Message,
{
    pub process: Child,
    pub stdout: ChildStdout,
    pub stdin: ChildStdin,
    /* private fields */
}

This is the basis of a UCI connection; use EngineConnection or GuiConnection instead.

Fields

process: Child

stdout: ChildStdout

stdin: ChildStdin

Implementations

impl<MSend, MReceive> UciConnection<MSend, MReceive>

where MSend: Message, MReceive: Message,

pub fn new_from_path(path: &str) -> Result<Self, UciCreationError>

Creates a new UCI connection from the given executable path.

Errors

• Spawning the process errored.
• Stdout is None.
• Stdin is None.

pub fn send_message(&mut self, message: &MSend) -> Result<()>

Sends a message.

Errors

See Write::write_all.

pub fn skip_lines(&mut self, count: usize) -> Result<()>

Skips some lines.

Errors

See Read::read_exact.

pub fn read_message( &mut self ) -> Result<MReceive, UciReadMessageError<MReceive::ParameterPointer>>

Reads a line and attempts to parse it into a message.

Errors

• Reading resulted in an IO error.
• Parsing the message errors.

pub fn read_line(&mut self) -> Result<String>

Reads one line without the trailing '\n' character.

Errors

• Reading resulted in an IO error.
• Parsing the message errors.

impl UciConnection<GuiMessage, EngineMessage>

pub fn use_uci(&mut self) -> Result<(Option<IdMessageKind>, Vec<OptionMessage>)>

Sends the GuiMessage::UseUci message and returns the engine’s ID and a vector of options once the uciok message is received.

Errors

See Write::write_all.

pub fn go( &mut self, message: GoMessage ) -> Result<(Vec<InfoMessage>, BestMoveMessage)>

Sends the go message to the engine and waits for the bestmove message response, returning it, along with a list of info messages.

See also the Self::go_async function, which can be interrupted.

Errors

• Writing (sending the message) errored.
• Reading (reading back the responses) errored.

pub fn go_async( arc_self: Arc<Mutex<Self>>, message: GoMessage ) -> GuiToEngineUciConnectionGo<impl FnOnce() -> Result<(), GuiToEngineUciConnectionGoError>>

Sends the go message to the engine and waits for the bestmove message response, returning it. The info messages are sent through the returned receiver.

See also:

• The Self::go function for a simpler alternative, but one that cannot be interrupted.
• The go_stop example.

Errors

• Writing (sending the message) errored.
• Reading (reading back the responses) errored.

pub fn is_ready(&mut self) -> Result<()>

Sends the isready message and waits for the readyok response.

Errors

• Writing (sending the message) errored.
• Reading (reading until readyok) errored.

Trait Implementations

impl<MSend, MReceive> Debug for UciConnection<MSend, MReceive>

where MSend: Message + Debug, MReceive: Message + Debug,

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

Formats the value using the given formatter.