Struct IpV4Address

#[repr(C)]
pub struct IpV4Address { /* private fields */ }

Implementations

impl IpV4Address

pub fn new<octets: Into<[u8; 4]>>(octets: octets) -> Self

pub fn as_bytes(&self) -> &[u8]

pub fn as_bytes_mut(&mut self) -> &mut [u8]

impl IpV4Address

pub const UNSPECIFIED: Self

An unspecified IpV4Address

pub const fn unicast_scope(self) -> Option<UnicastScope>

Returns the ip::UnicastScope for the given address

See the IANA Registry for more details.

use s2n_quic_core::inet::{IpV4Address, ip::UnicastScope::*};

assert_eq!(IpV4Address::from([0, 0, 0, 0]).unicast_scope(), None);
assert_eq!(IpV4Address::from([127, 0, 0, 1]).unicast_scope(), Some(Loopback));
assert_eq!(IpV4Address::from([127, 1, 1, 1]).unicast_scope(), Some(Loopback));
assert_eq!(IpV4Address::from([10, 0, 0, 1]).unicast_scope(), Some(Private));
assert_eq!(IpV4Address::from([100, 64, 0, 1]).unicast_scope(), Some(Private));
assert_eq!(IpV4Address::from([169, 254, 1, 2]).unicast_scope(), Some(LinkLocal));
assert_eq!(IpV4Address::from([192, 0, 0, 1]).unicast_scope(), None);
assert_eq!(IpV4Address::from([192, 0, 0, 9]).unicast_scope(), Some(Global));
assert_eq!(IpV4Address::from([192, 0, 0, 10]).unicast_scope(), Some(Global));
assert_eq!(IpV4Address::from([192, 0, 2, 1]).unicast_scope(), None);
assert_eq!(IpV4Address::from([198, 18, 0, 0]).unicast_scope(), None);
assert_eq!(IpV4Address::from([198, 19, 1, 1]).unicast_scope(), None);
assert_eq!(IpV4Address::from([233, 252, 0, 1]).unicast_scope(), None);
assert_eq!(IpV4Address::from([240, 255, 255, 255]).unicast_scope(), None);
assert_eq!(IpV4Address::from([255, 255, 255, 255]).unicast_scope(), None);
assert_eq!(IpV4Address::from([92, 88, 99, 123]).unicast_scope(), Some(Global));
assert_eq!(IpV4Address::from([168, 254, 169, 253]).unicast_scope(), Some(Global));
assert_eq!(IpV4Address::from([224, 0, 0, 1]).unicast_scope(), Some(Global));

pub const fn to_ipv6_mapped(self) -> IpV6Address

Converts the IP address into a IPv6 mapped address

pub fn with_port(self, port: u16) -> SocketAddressV4

Trait Implementations

impl Clone for IpV4Address

fn clone(&self) -> IpV4Address

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IpV4Address

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

Formats the value using the given formatter.

impl<'a> DecoderValue<'a> for &'a IpV4Address

where IpV4Address: FromBytes,

fn decode(buffer: DecoderBuffer<'a>) -> DecoderBufferResult<'a, Self>

impl<'a> DecoderValue<'a> for IpV4Address

where IpV4Address: FromBytes,

fn decode(buffer: DecoderBuffer<'a>) -> DecoderBufferResult<'a, Self>

impl<'a> DecoderValueMut<'a> for &'a IpV4Address

where IpV4Address: FromBytes,

fn decode_mut(buffer: DecoderBufferMut<'a>) -> DecoderBufferMutResult<'a, Self>

impl<'a> DecoderValueMut<'a> for &'a mut IpV4Address

where IpV4Address: FromBytes,

fn decode_mut(buffer: DecoderBufferMut<'a>) -> DecoderBufferMutResult<'a, Self>

impl<'a> DecoderValueMut<'a> for IpV4Address

where IpV4Address: FromBytes,

fn decode_mut(buffer: DecoderBufferMut<'a>) -> DecoderBufferMutResult<'a, Self>

impl Default for IpV4Address

fn default() -> IpV4Address

Returns the “default value” for a type.

impl Display for IpV4Address

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

Formats the value using the given formatter.

impl<'a> EncoderValue for &'a IpV4Address

where IpV4Address: IntoBytes,

fn encoding_size(&self) -> usize

Returns the encoding size with no buffer constrains

fn encoding_size_for_encoder<E: Encoder>(&self, _encoder: &E) -> usize

Returns the encoding size for the given encoder’s capacity

fn encode<E: Encoder>(&self, encoder: &mut E)

Encodes the value into the encoder

fn encode_mut<E>(&mut self, encoder: &mut E)

where E: Encoder,

Encodes the value into the encoder, while potentially mutating the value itself

fn encode_with_len_prefix<Len, E>(&self, encoder: &mut E)

where Len: TryFrom<usize> + EncoderValue, E: Encoder, Self: Sized, <Len as TryFrom<usize>>::Error: Debug,

Encodes the value into the encoder with a prefix of Len

fn encode_to_vec(&self) -> Vec<u8>

impl<'a> EncoderValue for &'a mut IpV4Address

where IpV4Address: IntoBytes,

fn encoding_size(&self) -> usize

Returns the encoding size with no buffer constrains

fn encoding_size_for_encoder<E: Encoder>(&self, _encoder: &E) -> usize

Returns the encoding size for the given encoder’s capacity

fn encode<E: Encoder>(&self, encoder: &mut E)

Encodes the value into the encoder

fn encode_mut<E>(&mut self, encoder: &mut E)

where E: Encoder,

Encodes the value into the encoder, while potentially mutating the value itself

fn encode_with_len_prefix<Len, E>(&self, encoder: &mut E)

where Len: TryFrom<usize> + EncoderValue, E: Encoder, Self: Sized, <Len as TryFrom<usize>>::Error: Debug,

Encodes the value into the encoder with a prefix of Len

fn encode_to_vec(&self) -> Vec<u8>

impl EncoderValue for IpV4Address

where IpV4Address: IntoBytes,

fn encoding_size(&self) -> usize

Returns the encoding size with no buffer constrains

fn encoding_size_for_encoder<E: Encoder>(&self, _encoder: &E) -> usize

Returns the encoding size for the given encoder’s capacity

fn encode<E: Encoder>(&self, encoder: &mut E)

Encodes the value into the encoder

fn encode_mut<E>(&mut self, encoder: &mut E)

where E: Encoder,

Encodes the value into the encoder, while potentially mutating the value itself

fn encode_with_len_prefix<Len, E>(&self, encoder: &mut E)

where Len: TryFrom<usize> + EncoderValue, E: Encoder, Self: Sized, <Len as TryFrom<usize>>::Error: Debug,

Encodes the value into the encoder with a prefix of Len

fn encode_to_vec(&self) -> Vec<u8>

impl<'a> From<&'a IpV4Address> for IpAddressRef<'a>

fn from(ip: &'a IpV4Address) -> Self

Converts to this type from the input type.

impl From<&Ipv4Addr> for IpV4Address

fn from(address: &Ipv4Addr) -> Self

Converts to this type from the input type.

impl From<[u8; 4]> for IpV4Address

fn from(octets: [u8; 4]) -> Self

Converts to this type from the input type.

impl From<IpV4Address> for [u8; 4]

fn from(address: IpV4Address) -> Self

Converts to this type from the input type.

impl From<IpV4Address> for IpAddress

fn from(ip: IpV4Address) -> Self

Converts to this type from the input type.

impl From<IpV4Address> for Ipv4Addr

fn from(address: IpV4Address) -> Self

Converts to this type from the input type.

impl From<Ipv4Addr> for IpV4Address

fn from(address: Ipv4Addr) -> Self

Converts to this type from the input type.

impl FromBytes for IpV4Address

where [u8; 4]: FromBytes,

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

impl FromZeros for IpV4Address

where [u8; 4]: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

impl Hash for IpV4Address

fn hash<H: Hasher>(&self, hasher: &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 IntoBytes for IpV4Address

where [u8; 4]: IntoBytes,

fn as_bytes(&self) -> &[u8]

where Self: Immutable,

Gets the bytes of this value.

fn as_mut_bytes(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

impl Ord for IpV4Address

fn cmp(&self, other: &IpV4Address) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for IpV4Address

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for IpV4Address

fn partial_cmp(&self, other: &IpV4Address) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFromBytes for IpV4Address

where [u8; 4]: TryFromBytes,

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.

impl Unspecified for IpV4Address

fn is_unspecified(&self) -> bool

Returns true if the value is unspecified

fn filter_unspecified(self) -> Option<Self>

Coerce a potentially unspecified value into an Option<Self>

impl Copy for IpV4Address

impl Eq for IpV4Address

impl Immutable for IpV4Address

where [u8; 4]: Immutable,

impl StructuralPartialEq for IpV4Address

impl Unaligned for IpV4Address

where [u8; 4]: Unaligned,