plug 0.1.0

A library for type-safe interprocess communication
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

use crate::connection::{self, Connection};

use tokio::io;
use tokio::net;

use std::marker::PhantomData;

/// A type-safe connection endpoint with a name.
#[derive(Debug, Clone, Copy)]
pub struct Plug<I, O> {
    pub(crate) name: &'static str,
    _types: PhantomData<(I, O)>,
}

impl<I, O> Plug<I, O> {
    /// Creates a new [`Plug`] with the given name.
    pub const fn new(name: &'static str) -> Self {
        Self {
            name,
            _types: PhantomData,
        }
    }

    /// Connects to the [`Plug`] in the given server address, producing a type-safe [`Connection`].
    pub async fn connect(self, address: impl net::ToSocketAddrs) -> io::Result<Connection<I, O>> {
        let stream = net::TcpStream::connect(address).await?;

        self.seize(stream).await
    }

    /// Seizes an existing TCP connection and redirects it through the [`Plug`].
    pub async fn seize(self, mut stream: net::TcpStream) -> io::Result<Connection<I, O>> {
        connection::write_json(&mut stream, self.name).await?;

        Ok(Connection::seize(stream))
    }
}