Struct candid_client::candid_connection::CandidConnection

pub struct CandidConnection { /* fields omitted */ }

Methods

impl CandidConnection

A connection to a CANdid server. Simply contains a TcpStream wrapped by a BufReader. Handles the communication with a server by reading one can frame at a time from a TCP stream.

pub fn new<A: ToSocketAddrs>(addr: A) -> Result<CandidConnection, Error>

Creates a new CandidConnection with a server designated at addr

pub fn read_frame(&mut self) -> Result<String, Error>

Reads a single CAN frame sent by the server.

pub fn into_raw_stream(self) -> TcpStream

Unwraps the internal BufReader and returns the raw TcpStream.

Note that any leftover data in the buffer will be lost.

pub fn into_buffer(self) -> BufReader<TcpStream>

Unwraps this CandidConnection and returns the underlying BufReader.

pub fn lines(self) -> Lines<BufReader<TcpStream>>

Returns an iterator over the raw lines form the underlying TcpStream.