Struct PeerAddress

pub struct PeerAddress(pub [u8; 16]);

A container for an IPv4 or IPv6 address. Rules: – If this is an IPv6 address, the octets are in network byte order – If this is an IPv4 address, the octets must encode an IPv6-to-IPv4-mapped address

Tuple Fields

0: [u8; 16]

Implementations

impl PeerAddress

pub fn as_ptr(&self) -> *const u8

Converts the object to a raw pointer

pub fn as_mut_ptr(&mut self) -> *mut u8

Converts the object to a mutable raw pointer

pub fn len(&self) -> usize

Returns the length of the object as an array

pub fn is_empty(&self) -> bool

Returns whether the object, as an array, is empty. Always false.

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

Returns the underlying bytes.

pub fn to_bytes(&self) -> [u8; 16]

Returns the underlying bytes.

pub fn into_bytes(self) -> [u8; 16]

Returns the underlying bytes.

impl PeerAddress

pub fn from_hex(hex_str: &str) -> Result<PeerAddress, HexError>

Instantiates from a hex string

pub fn from_bytes(inp: &[u8]) -> Option<PeerAddress>

Instantiates from a slice of bytes Note: if this type is a hashing type, this sets the hash result to inp exactly: this method does not perform the hash.

pub fn from_bytes_be(inp: &[u8]) -> Option<PeerAddress>

Instantiates from a slice of bytes, converting to host byte order

pub fn from_vec(inp: &Vec<u8>) -> Option<PeerAddress>

Instantiates from a vector of bytes

pub fn from_vec_be(b: &Vec<u8>) -> Option<PeerAddress>

Instantiates from a big-endian vector of bytes, converting to host byte order

pub fn to_hex(&self) -> String

Convert to a hex string

impl PeerAddress

pub fn from_slice(bytes: &[u8]) -> Option<PeerAddress>

pub fn is_ipv4(&self) -> bool

Is this an IPv4 address?

pub fn ipv4_octets(&self) -> Option<[u8; 4]>

Get the octet representation of this peer address as an IPv4 address. The last 4 bytes of the list contain the IPv4 address. This method returns None if the bytes don’t encode a valid IPv4-mapped address (i.e. ::ffff:0:0/96)

pub fn ipv4_bits(&self) -> Option<u32>

Return the bit representation of this peer address as an IPv4 address, in network byte order. Return None if this is not an IPv4 address.

pub fn to_socketaddr(&self, port: u16) -> SocketAddr

Convert to SocketAddr

pub fn from_socketaddr(addr: &SocketAddr) -> PeerAddress

Convert from socket address

pub fn from_ip(addr: &IpAddr) -> PeerAddress

Convert from IP address

pub fn from_ipv4(o1: u8, o2: u8, o3: u8, o4: u8) -> PeerAddress

Convert from ipv4 octets

pub fn is_anynet(&self) -> bool

Is this the any-network address? i.e. 0.0.0.0 (v4) or :: (v6)?

pub fn is_in_private_range(&self) -> bool

Is this a private IP address?

pub fn is_loopback(&self) -> bool

Is this a local loopback address?

pub fn to_bin(&self) -> String

Trait Implementations

impl AsRef<[u8]> for PeerAddress

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

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

impl Clone for PeerAddress

fn clone(&self) -> PeerAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PeerAddress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PeerAddress

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<PeerAddress, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for PeerAddress

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

Formats the value using the given formatter.

impl<'a> From<&'a [u8]> for PeerAddress

fn from(data: &'a [u8]) -> PeerAddress

Converts to this type from the input type.

impl From<[u8; 16]> for PeerAddress

fn from(o: [u8; 16]) -> Self

Converts to this type from the input type.

impl Hash for PeerAddress

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher,

Feeds a slice of this type into the given Hasher.

impl Index<Range<usize>> for PeerAddress

type Output = [u8]

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for PeerAddress

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for PeerAddress

type Output = [u8]

The returned type after indexing.

fn index(&self, _: RangeFull) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for PeerAddress

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &[u8]

Performs the indexing (container[index]) operation.

impl Index<usize> for PeerAddress

type Output = u8

The returned type after indexing.

fn index(&self, index: usize) -> &u8

Performs the indexing (container[index]) operation.

impl Ord for PeerAddress

fn cmp(&self, other: &PeerAddress) -> 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 PeerAddress

fn eq(&self, other: &PeerAddress) -> 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 PeerAddress

fn partial_cmp(&self, other: &PeerAddress) -> 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 Serialize for PeerAddress

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StacksMessageCodec for PeerAddress

fn consensus_serialize<W: Write>(&self, fd: &mut W) -> Result<(), Error>

serialize implementors should never error unless there is an underlying failure in writing to the fd

fn consensus_deserialize<R: Read>(fd: &mut R) -> Result<PeerAddress, Error>

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

where Self: Sized,

Convenience for serialization to a vec. this function unwraps any underlying serialization error

impl Copy for PeerAddress

impl Eq for PeerAddress