Struct IpHint

#[repr(transparent)]
pub struct IpHint<T>(pub Vec<T>);

RFC 9460 SVCB and HTTPS Resource Records, Nov 2023

   7.3.  "ipv4hint" and "ipv6hint"

  The "ipv4hint" and "ipv6hint" keys convey IP addresses that clients
  MAY use to reach the service.  If A and AAAA records for TargetName
  are locally available, the client SHOULD ignore these hints.
  Otherwise, clients SHOULD perform A and/or AAAA queries for
  TargetName per Section 3, and clients SHOULD use the IP address in
  those responses for future connections.  Clients MAY opt to terminate
  any connections using the addresses in hints and instead switch to
  the addresses in response to the TargetName query.  Failure to use A
  and/or AAAA response addresses could negatively impact load balancing
  or other geo-aware features and thereby degrade client performance.

  The presentation value SHALL be a comma-separated list (Appendix A.1)
  of one or more IP addresses of the appropriate family in standard
  textual format [RFC5952] [RFC4001].  To enable simpler parsing, this
  SvcParamValue MUST NOT contain escape sequences.

  The wire format for each parameter is a sequence of IP addresses in
  network byte order (for the respective address family).  Like an A or
  AAAA RRset, the list of addresses represents an unordered collection,
  and clients SHOULD pick addresses to use in a random order.  An empty
  list of addresses is invalid.

  When selecting between IPv4 and IPv6 addresses to use, clients may
  use an approach such as Happy Eyeballs [HappyEyeballsV2].  When only
  "ipv4hint" is present, NAT64 clients may synthesize IPv6 addresses as
  specified in [RFC7050] or ignore the "ipv4hint" key and wait for AAAA
  resolution (Section 3).  For best performance, server operators
  SHOULD include an "ipv6hint" parameter whenever they include an
  "ipv4hint" parameter.

  These parameters are intended to minimize additional connection
  latency when a recursive resolver is not compliant with the
  requirements in Section 4 and SHOULD NOT be included if most clients
  are using compliant recursive resolvers.  When TargetName is the
  service name or the owner name (which can be written as "."), server
  operators SHOULD NOT include these hints, because they are unlikely
  to convey any performance benefit.

Tuple Fields

0: Vec<T>

Trait Implementations

impl<'r, T> BinDecodable<'r> for IpHint<T>

where T: BinDecodable<'r>,

fn read(decoder: &mut BinDecoder<'r>) -> Result<Self, ProtoError>

The wire format for each parameter is a sequence of IP addresses in network byte order (for the respective address family). Like an A or AAAA RRSet, the list of addresses represents an unordered collection, and clients SHOULD pick addresses to use in a random order. An empty list of addresses is invalid.

fn from_bytes(bytes: &'r [u8]) -> Result<Self, ProtoError>

Returns the object in binary form

impl<T> BinEncodable for IpHint<T>

where T: BinEncodable,

fn emit(&self, encoder: &mut BinEncoder<'_>) -> Result<(), ProtoError>

The wire format for each parameter is a sequence of IP addresses in network byte order (for the respective address family). Like an A or AAAA RRSet, the list of addresses represents an unordered collection, and clients SHOULD pick addresses to use in a random order. An empty list of addresses is invalid.

fn to_bytes(&self) -> Result<Vec<u8>, ProtoError>

Returns the object in binary form

impl<T: Clone> Clone for IpHint<T>

fn clone(&self) -> IpHint<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for IpHint<T>

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

Formats the value using the given formatter.

impl<T> Display for IpHint<T>

where T: Display,

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

The presentation value SHALL be a comma-separated list (Appendix A.1) of one or more IP addresses of the appropriate family in standard textual format RFC 5952. To enable simpler parsing, this SvcParamValue MUST NOT contain escape sequences.

impl<T: Hash> Hash for IpHint<T>

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<T: PartialEq> PartialEq for IpHint<T>

fn eq(&self, other: &IpHint<T>) -> 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<T: Eq> Eq for IpHint<T>

impl<T> StructuralPartialEq for IpHint<T>