Struct ClientSubnet

pub struct ClientSubnet { /* private fields */ }

Option data for the client subnet option.

This option allows a resolver to include information about the network a query originated from. This information can then be used by an authoritative server to provide the best response for this network.

The option identifies the network through an address prefix, i.e., an IP address of which only a certain number of left-side bits is interpreted. The option uses two such numbers: The source prefix length is the number of bits provided by the client when describing its network and the scope prefix length is the number of bits that the server considered when providing the answer. The scope prefix length is zero in a query. It can be used by a caching resolver to cache multiple responses for different client subnets.

The option is defined in RFC 7871 which also includes some guidance on its use.

Implementations

impl ClientSubnet

pub fn new( source_prefix_len: u8, scope_prefix_len: u8, addr: IpAddr, ) -> ClientSubnet

Creates a new client subnet value.

The function is very forgiving regarding the arguments and corrects illegal values. That is, it limit the prefix lengths given to a number meaningful for the address family. It will also set all bits not covered by the source prefix length in the address to zero.

pub fn source_prefix_len(&self) -> u8

Returns the source prefix length.

The source prefix length is the prefix length as specified by the client in a query.

pub fn scope_prefix_len(&self) -> u8

Returns the scope prefix length.

The scope prefix length is the prefix length used by the server for its answer.

pub fn addr(&self) -> IpAddr

Returns the address.

pub fn parse<Octs: AsRef<[u8]>>( parser: &mut Parser<'_, Octs>, ) -> Result<Self, ParseError>

Parses a value from its wire format.

Trait Implementations

impl Clone for ClientSubnet

fn clone(&self) -> ClientSubnet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ComposeOptData for ClientSubnet

fn compose_len(&self) -> u16

fn compose_option<Target: OctetsBuilder + ?Sized>( &self, target: &mut Target, ) -> Result<(), Target::AppendError>

impl Debug for ClientSubnet

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

Formats the value using the given formatter.

impl Display for ClientSubnet

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

Formats the value using the given formatter.

impl<Octs, Name> From<ClientSubnet> for AllOptData<Octs, Name>

fn from(value: ClientSubnet) -> Self

Converts to this type from the input type.

impl Hash for ClientSubnet

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 OptData for ClientSubnet

fn code(&self) -> OptionCode

Returns the option code associated with this option.

impl Ord for ClientSubnet

fn cmp(&self, other: &ClientSubnet) -> 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<'a, Octs: AsRef<[u8]>> ParseOptData<'a, Octs> for ClientSubnet

fn parse_option( code: OptionCode, parser: &mut Parser<'a, Octs>, ) -> Result<Option<Self>, ParseError>

Parses the option code data.

impl PartialEq for ClientSubnet

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

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

impl Eq for ClientSubnet

impl StructuralPartialEq for ClientSubnet