Struct ClientAddress 

pub struct ClientAddress(/* private fields */);

A validated client socket address.

This newtype wrapper provides type safety and prevents mixing up client addresses with other socket addresses in the codebase.

Examples

use std::net::SocketAddr;
use nntp_proxy::types::ClientAddress;

let addr: SocketAddr = "127.0.0.1:8119".parse().unwrap();
let client_addr = ClientAddress::from(addr);

println!("Client connected from: {}", client_addr);

Implementations

impl ClientAddress

pub const fn new(addr: SocketAddr) -> Self

Create a new client address from a socket address.

Examples

use std::net::SocketAddr;
use nntp_proxy::types::ClientAddress;

let addr: SocketAddr = "192.168.1.100:12345".parse().unwrap();
let client_addr = ClientAddress::new(addr);

pub const fn as_socket_addr(&self) -> &SocketAddr

Get the underlying socket address.

Examples

use std::net::SocketAddr;
use nntp_proxy::types::ClientAddress;

let addr: SocketAddr = "10.0.0.5:9999".parse().unwrap();
let client_addr = ClientAddress::from(addr);

assert_eq!(client_addr.as_socket_addr(), &addr);

pub const fn into_inner(self) -> SocketAddr

Convert into the underlying socket address.

Examples

use std::net::SocketAddr;
use nntp_proxy::types::ClientAddress;

let addr: SocketAddr = "172.16.0.1:5555".parse().unwrap();
let client_addr = ClientAddress::from(addr);
let socket_addr = client_addr.into_inner();

assert_eq!(socket_addr, addr);

pub const fn is_ipv4(&self) -> bool

Check if this is an IPv4 address.

Examples

use nntp_proxy::types::ClientAddress;
use std::net::SocketAddr;

let addr = ClientAddress::from("127.0.0.1:8119".parse::<SocketAddr>().unwrap());
assert!(addr.is_ipv4());

let addr6 = ClientAddress::from("[::1]:8119".parse::<SocketAddr>().unwrap());
assert!(!addr6.is_ipv4());

pub const fn is_ipv6(&self) -> bool

Check if this is an IPv6 address.

Examples

use nntp_proxy::types::ClientAddress;
use std::net::SocketAddr;

let addr = ClientAddress::from("[::1]:8119".parse::<SocketAddr>().unwrap());
assert!(addr.is_ipv6());

let addr4 = ClientAddress::from("127.0.0.1:8119".parse::<SocketAddr>().unwrap());
assert!(!addr4.is_ipv6());

Methods from Deref<Target = SocketAddr>

pub fn ip(&self) -> IpAddr

Returns the IP address associated with this socket address.

Examples

use std::net::{IpAddr, Ipv4Addr, SocketAddr};

let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
assert_eq!(socket.ip(), IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));

pub fn port(&self) -> u16

Returns the port number associated with this socket address.

Examples

use std::net::{IpAddr, Ipv4Addr, SocketAddr};

let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
assert_eq!(socket.port(), 8080);

pub fn is_ipv4(&self) -> bool

Returns true if the IP address in this SocketAddr is an IPv4 address, and false otherwise.

Examples

use std::net::{IpAddr, Ipv4Addr, SocketAddr};

let socket = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 8080);
assert_eq!(socket.is_ipv4(), true);
assert_eq!(socket.is_ipv6(), false);

pub fn is_ipv6(&self) -> bool

Returns true if the IP address in this SocketAddr is an IPv6 address, and false otherwise.

Examples

use std::net::{IpAddr, Ipv6Addr, SocketAddr};

let socket = SocketAddr::new(IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 65535, 0, 1)), 8080);
assert_eq!(socket.is_ipv4(), false);
assert_eq!(socket.is_ipv6(), true);

Trait Implementations

impl AsRef<SocketAddr> for ClientAddress

fn as_ref(&self) -> &SocketAddr

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ClientAddress

fn clone(&self) -> ClientAddress

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ClientAddress

impl Debug for ClientAddress

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for ClientAddress

type Target = SocketAddr

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for ClientAddress

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for ClientAddress

impl From<ClientAddress> for SocketAddr

fn from(value: ClientAddress) -> Self

Converts to this type from the input type.

impl From<SocketAddr> for ClientAddress

fn from(value: SocketAddr) -> Self

Converts to this type from the input type.

impl Hash for ClientAddress

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ClientAddress

fn eq(&self, other: &ClientAddress) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ClientAddress