# Connection 💌
[
](https://github.com/wcygan/connection)
[
](https://crates.io/crates/connection)
[
](https://docs.rs/connection)
[
](https://github.com/wcygan/connection/actions?query=branch%3Amain)
[](https://codecov.io/gh/wcygan/connection)
A TCP-based connection that can send & receive serializable objects.
# Usage
Add this to your Cargo.toml:
```toml
[dependencies]
connection = "0.2.5"
```
You can create a `Connection` by connecting like so:
```rust
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:
```rust
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).await.unwrap();
}
/// Code running server side
async fn server_side(mut server_conn: Connection) {
let message: Message = server_conn.read::().await.unwrap().unwrap();
}
```