Adding `connection` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add connection

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

connection = "0.2.5"

The connection library will be automatically available globally. Read the connection library documentation.

Back to the crate overview.

Readme

Connection 💌

A TCP-based connection that can send & receive serializable objects.

Usage

Add this to your Cargo.toml:

[dependencies]
connection = "0.2.5"

You can create a Connection by connecting like so:

use connection::Connection;

#[tokio::main]
async fn main() {
  let mut conn = Connection::connect("127.0.0.1:8080").await.unwrap();
}

You can use the Connection to send and receive serializable objects:

use connection::Connection;
use serde::{Serialize, Deserialize};

/// A (de)serializable type shared between client and server
#[derive(Serialize, Deserialize)]
struct Message {
  id: u32,
  data: String,
}

/// Code running client side
async fn client_side(mut client_conn: Connection) {
  let message = Message {
    id: 1,
    data: "Hello, world!".to_string(),
  };

  client_conn.write::<Message>(&message).await.unwrap();
}

/// Code running server side
async fn server_side(mut server_conn: Connection) {
  let message: Message = server_conn.read::<Message>().await.unwrap().unwrap();
}

Adding connection library as a dependency

Adding `connection` library as a dependency