Struct IpAddr

Source

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

Available on crate feature net only.

Expand description

An IP address (IPv4 or IPv6).

This type wraps the standard library’s IpAddr to provide type safety and consistent API with other types in this crate. It uses the newtype pattern with #[repr(transparent)] for zero-cost abstraction.

§Invariants

The inner value is always a valid IP address
IPv4 addresses are 4 octets (0-255 each)
IPv6 addresses are 8 groups of 16 bits

§Examples

use bare_types::net::IpAddr;
use core::net::{Ipv4Addr, Ipv6Addr};

// Create an IPv4 address
let v4 = IpAddr::new(core::net::IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));
assert!(v4.is_ipv4());
assert!(v4.is_loopback());

// Create an IPv6 address
let v6 = IpAddr::new(core::net::IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)));
assert!(v6.is_ipv6());
assert!(v6.is_loopback());

// Access the inner value
let inner: core::net::IpAddr = v4.into_inner();
assert_eq!(inner, core::net::IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));

// Parse from string
let addr: IpAddr = "192.168.1.1".parse()?;
assert!(addr.is_ipv4());

Implementations§

Source §

impl IpAddr

Source

pub const fn new(inner: IpAddr) -> Self

Creates a new IP address from a standard library IpAddr.

§Examples

use bare_types::net::IpAddr;
use core::net::Ipv4Addr;

let addr = IpAddr::new(core::net::IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));
assert!(addr.is_ipv4());

Source

pub const fn as_inner(&self) -> &IpAddr

Returns a reference to the underlying IpAddr.

§Examples

use bare_types::net::IpAddr;
use core::net::Ipv4Addr;

let addr = IpAddr::new(core::net::IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));
let inner = addr.as_inner();
assert_eq!(inner, &core::net::IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));

Source

pub const fn into_inner(self) -> IpAddr

Consumes this IP address and returns the underlying IpAddr.

§Examples

use bare_types::net::IpAddr;
use core::net::Ipv4Addr;

let addr = IpAddr::new(core::net::IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));
let inner: core::net::IpAddr = addr.into_inner();
assert_eq!(inner, core::net::IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));

Source

pub const fn is_ipv4(&self) -> bool

Returns true if this is an IPv4 address.

§Examples

use bare_types::net::IpAddr;
use core::net::{Ipv4Addr, Ipv6Addr};

let v4 = IpAddr::new(core::net::IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));
let v6 = IpAddr::new(core::net::IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)));

assert!(v4.is_ipv4());
assert!(!v6.is_ipv4());

Source

pub const fn is_ipv6(&self) -> bool

Returns true if this is an IPv6 address.

§Examples

use bare_types::net::IpAddr;
use core::net::{Ipv4Addr, Ipv6Addr};

let v4 = IpAddr::new(core::net::IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));
let v6 = IpAddr::new(core::net::IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)));

assert!(!v4.is_ipv6());
assert!(v6.is_ipv6());

Source

pub const fn is_loopback(&self) -> bool

Returns true if this is a loopback address.

For IPv4, this is 127.0.0.1. For IPv6, this is ::1.

§Examples

use bare_types::net::IpAddr;
use core::net::{Ipv4Addr, Ipv6Addr};

let v4_loopback = IpAddr::new(core::net::IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));
let v6_loopback = IpAddr::new(core::net::IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)));

assert!(v4_loopback.is_loopback());
assert!(v6_loopback.is_loopback());

Source

pub const fn is_unspecified(&self) -> bool

Returns true if this is an unspecified address.

For IPv4, this is 0.0.0.0. For IPv6, this is ::.

§Examples

use bare_types::net::IpAddr;
use core::net::{Ipv4Addr, Ipv6Addr};

let v4_unspecified = IpAddr::new(core::net::IpAddr::V4(Ipv4Addr::new(0, 0, 0, 0)));
let v6_unspecified = IpAddr::new(core::net::IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)));

assert!(v4_unspecified.is_unspecified());
assert!(v6_unspecified.is_unspecified());

Source

pub const fn is_multicast(&self) -> bool

Returns true if this is a multicast address.

§Examples

use bare_types::net::IpAddr;
use core::net::{Ipv4Addr, Ipv6Addr};

let v4_multicast = IpAddr::new(core::net::IpAddr::V4(Ipv4Addr::new(224, 0, 0, 1)));
let v6_multicast = IpAddr::new(core::net::IpAddr::V6(Ipv6Addr::new(0xff00, 0, 0, 0, 0, 0, 0, 0)));

assert!(v4_multicast.is_multicast());
assert!(v6_multicast.is_multicast());