Struct Connection

pub struct Connection<R: BufRead, W: Write> { /* private fields */ }

Use this type when you have both a reader and writer, and want them to be grouped together.

There are situations in which you have both a reader and a writer being passed around code, always kept together. This forms what is known as a ‘data clump’, and harms code readability. By grouping the two together it makes clear that they are both needed, and prevents mistakes when one is forgotten.

Connection is internally a pair of a reader and a writer, and delegates to crate::read and crate::write for Connection::read and Connection::write respectively.

Implementations

impl<R: BufRead, W: Write> Connection<R, W>

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

impl<'a> Connection<BufReader<&'a mut ChildStdout>, &'a mut ChildStdin>

pub fn new_from_child(child: &'a mut Child) -> Option<Self>

Creates a new Connection that uses the stdin of a child process as the writer and the child process’ stdout as the reader. This facilitates communication with this child process by passing data into its stdin and reading from its stdout.

impl Connection<BufReader<Stdin>, Stdout>

pub fn new_from_stdio() -> Self

Creates a new Connection from the stdio of the current process – stdin is used as the reader and stdout is used as the writer.

impl Connection<BufReader<TcpStream>, TcpStream>

pub fn new_from_tcp_stream(tcp_stream: TcpStream) -> Result<Self>

Creates a new Connection from a TCP stream.

pub fn shutdown(self) -> Result<()>

Closes the TCP stream.

impl<R: BufRead, W: Write> Connection<R, W>

pub fn read<T: DeserializeOwned>(&mut self) -> Result<T, ReadError>

Reads a line from the reader and deserializes it into a given type.

pub fn write<T: Serialize>(&mut self, t: &T) -> Result<(), WriteError>

Writes a given value to the writer, serializing it into JSON.

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

Flushes the contained writer’s buffer.

Trait Implementations

impl<R: Clone + BufRead, W: Clone + Write> Clone for Connection<R, W>

fn clone(&self) -> Connection<R, W>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<R: Debug + BufRead, W: Debug + Write> Debug for Connection<R, W>

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

Formats the value using the given formatter.

impl<R: Default + BufRead, W: Default + Write> Default for Connection<R, W>

fn default() -> Connection<R, W>

Returns the “default value” for a type.

impl<R: Hash + BufRead, W: Hash + Write> Hash for Connection<R, W>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<R: Ord + BufRead, W: Ord + Write> Ord for Connection<R, W>

fn cmp(&self, other: &Connection<R, W>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<R: PartialEq + BufRead, W: PartialEq + Write> PartialEq for Connection<R, W>

fn eq(&self, other: &Connection<R, W>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<R: PartialOrd + BufRead, W: PartialOrd + Write> PartialOrd for Connection<R, W>

fn partial_cmp(&self, other: &Connection<R, W>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<R: Copy + BufRead, W: Copy + Write> Copy for Connection<R, W>

impl<R: Eq + BufRead, W: Eq + Write> Eq for Connection<R, W>

impl<R: BufRead, W: Write> StructuralPartialEq for Connection<R, W>