Crate ruci

A note on “GUI”

Whenever you see “GUI” in the documentation, it doesn’t mean “Graphical User Interface”. It means “whatever controls the engine”. It’s called that because that’s how it’s referred to in the UCI protocol and elsewhere.

A note on message enums

If you write something like:

let _: engine::Message = engine::Message::Info(Box::new(Info::default()));
let _: Message = Message::Gui(gui::Message::Go(Go::default()));

Use instead:

let _: engine::Message = Info::default().into();
let _: Message = Go::default().into();

In short, lower level messages can be converted to the higher level.

A note on Display impls

Display implementations of messages do not include the final newline (\n) character.

Re-exports

pub use engine::*;

pub use gui::*;

Modules

engine

gui

traits

Structs

Engineengine-sync

Communicate with a chess engine.

Guigui-sync

Communicate with a chess GUI.

MessageParseError

Something went wrong with parsing a message.

Enums

FromProcessError

Converting a process to an engine failed.

Message

Any message, sent from the engine or GUI.

MessageParseErrorKind

ReadErrorio

Reading a message from the engine failed.

ReadWriteErrorio

Reading/sending a message from/to the engine failed.