tcp-channel 0.3.2

SPSC channels, working on everything that implements Read and Write
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

use std::io::{BufWriter, Write};
use std::marker::PhantomData;
use std::net::{TcpStream, ToSocketAddrs};

use bincode::Config;
use byteorder::WriteBytesExt;
use serde::Serialize;

use crate::{ChannelSend, Endian, BigEndian, SendError};

/// The sending side of a channel.
pub struct Sender<T: Serialize, E: Endian, W: Write = BufWriter<TcpStream>> {
    writer: W,
    config: Config,
    _marker: PhantomData<(T, E)>,
}

/// A more convenient way of initializing senders.
pub struct SenderBuilder;

pub struct TypedSenderBuilder<T, W, E> {
    _marker: PhantomData<(T, W, E)>,
}

impl SenderBuilder {
    /// Begin building a new, buffered channel.
    pub fn new() -> TypedSenderBuilder<(), BufWriter<TcpStream>, BigEndian> {
        Self::buffered()
    }
    /// Begin building a new, buffered channel.
    pub fn buffered() -> TypedSenderBuilder<(), BufWriter<TcpStream>, BigEndian> {
        TypedSenderBuilder {
            _marker: PhantomData,
        }
    }
    /// Begin building a new, non-buffered channel.
    pub fn realtime() -> TypedSenderBuilder<(), TcpStream, BigEndian> {
        TypedSenderBuilder {
            _marker: PhantomData,
        }
    }
}
impl<T, W, E> TypedSenderBuilder<T, W, E> {
    /// Specify the type to send.
    pub fn with_type<U: Serialize>(self) -> TypedSenderBuilder<U, W, E> {
        TypedSenderBuilder {
            _marker: PhantomData,
        }
    }
    /// Specify the underlying writer type.
    pub fn with_writer<X: Write>(self) -> TypedSenderBuilder<T, X, E> {
        TypedSenderBuilder {
            _marker: PhantomData,
        }
    }
    /// Specify the endianness.
    pub fn with_endianness<F: Endian>(self) -> TypedSenderBuilder<T, W, F> {
        TypedSenderBuilder {
            _marker: PhantomData,
        }
    }
}
impl<T: Serialize, W: Write, E: Endian> TypedSenderBuilder<T, W, E> {
    /// Initialize the sender with the current variables.
    pub fn build(self, writer: W) -> Sender<T, E, W> {
        Sender {
            _marker: PhantomData,
            writer,
            config: E::config(),
        }
    }
}
impl<T: Serialize, E: Endian> TypedSenderBuilder<T, BufWriter<TcpStream>, E> {
    /// Connect to a listening receiver, at a specified address.
    pub fn connect<A: ToSocketAddrs>(self, address: A) -> std::io::Result<Sender<T, E, BufWriter<TcpStream>>> {
        let stream = TcpStream::connect(address)?;

        Ok(Sender {
            writer: BufWriter::new(stream),
            _marker: PhantomData,
            config: E::config(),
        })
    }
}
impl<T: Serialize, E: Endian> TypedSenderBuilder<T, TcpStream, E> {
    /// Connect to a listening receiver, at a specified address.
    pub fn connect<A: ToSocketAddrs>(self, address: A) -> std::io::Result<Sender<T, E, TcpStream>> {
        let stream = TcpStream::connect(address)?;
        stream.set_nodelay(true)?;

        Ok(Sender {
            writer: stream,
            _marker: PhantomData,
            config: E::config(),
        })
    }
}
impl<T: Serialize, E: Endian, W: Write> Sender<T, E, W> {
    pub fn flush(&mut self) -> std::io::Result<()> {
        self.writer.flush()
    }
}
impl<T: Serialize, E: Endian, W: Write> ChannelSend<T> for Sender<T, E, W> {
    type Error = SendError;
    fn send(&mut self, value: &T) -> Result<(), SendError> {
        let buffer = self.config.serialize(value)?;
        self.writer.write_u64::<E>(buffer.len() as u64)?;
        self.writer.write(&buffer)?;
        Ok(())
    }
}