Struct bgb_link::net::stream::BgbStream

pub struct BgbStream<T: Read + Write> { /* fields omitted */ }

Methods

impl<T: Read + Write> BgbStream<T>

pub fn wrap(inner: T) -> BgbStream<T>

Takes ownership of the given read/writer and uses it for communication.

For use over TCP, see connect.

pub fn read_raw(&mut self) -> Result<RawBgbCommand>

Reads 8 bytes from the connection and interprets the raw command data.

pub fn read(&mut self) -> Result<TypedBgbCommand>

Reads 8 bytes from the connection and interprets them as a command.

If the command is too malformed to interpret, returns an error of kind InvalidData.

pub fn write(&mut self, command: &impl BgbCommand) -> Result<()>

Serializes the command to an 8-byte packet and writes it to the stream.

impl BgbStream<TcpStream>

pub fn connect<A: ToSocketAddrs>(addr: A) -> Result<BgbStream<TcpStream>>

Establishes a TCP connection to a listening socket over the BGB protocol.

This method also enables TCP_NODELAY, as recommended in the spec, and waits for the handshake to complete before returning. If the other party provides an invalid handshake, returns an error of kind InvalidData.

pub fn maybe_read_raw(&mut self) -> Result<Option<RawBgbCommand>>

Uses TcpStream.peek to check if 8 bytes are available, and if so, reads them and interprets the raw data.

pub fn maybe_read(&mut self) -> Result<Option<TypedBgbCommand>>

As read but for maybe_read_raw instead of read_raw.

Trait Implementations

impl<T: Debug + Read + Write> Debug for BgbStream<T>

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

Formats the value using the given formatter.