trellis-net 0.1.0

A simple networking library for Rust.
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


// ===== Imports =====
#[macro_use] extern crate async_trait;
use std::net::{SocketAddr, IpAddr, Ipv4Addr};

use bytes::{BytesMut, BufMut};
// ===================

pub mod listener;
pub mod connection;
pub mod rw;
pub mod prelude;

/// # Address
/// A utility struct for representing Socket-Addresses.
#[derive(Clone, Copy, Debug, Hash, Eq, PartialEq)]
pub struct Address {
  /// Host
  pub host: (u8, u8, u8, u8),
  /// Port
  pub port: u16,
}

impl Address {
  /// ## Constructor
  /// Constructs a new instance of `Address`
  pub fn new(host: (u8, u8, u8, u8), port: u16) -> Self {
    Self { host, port }
  }
}

// Converts `Address` to `std::net::SocketAddr`
impl Into<SocketAddr> for Address {
  fn into(self) -> SocketAddr {
    let host = IpAddr::V4(Ipv4Addr::new(self.host.0, self.host.1, self.host.2, self.host.3));
    SocketAddr::new(host, self.port)
  }
}

// Converts `std::net::SocketAddr` to `Address`
impl From<SocketAddr> for Address {
  fn from(addr: SocketAddr) -> Self {
    if let IpAddr::V4(v4_addr) = addr.ip() {
      let host_octets = v4_addr.octets();
      let host = (host_octets[0], host_octets[1], host_octets[2], host_octets[3]);
      return Self { host, port: addr.port() }
    } else {
      panic!("Expected an IpV4 Socket Address")
    }
  }
}

/// # Zero-Filled-BytesMut
/// Helper function which returns a `BytesMut` of provided length with only zeroes.
pub fn zero_filled_bytes_mut(len: usize) -> BytesMut {
  let mut byts = BytesMut::with_capacity(len);
  byts.put(&*vec![0; len]);
  byts
}