Struct domain::base::opt::cookie::ClientCookie

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

A client cookie for DNS cookies.

The client cookies consists of exactly 8 octets. It is generated by a client for each server it sends queries to. It is important to use a different cookie for every server so a server cannot spoof answers for other servers.

Originally, it was suggested to include the client’s IP address when generating the cookie, but since the address may not be known when originating a request, this has been relaxed and it is now suggested that the cookies is just random data. If the rand feature is enabled, the new new_random constructor can be used to generate such a random cookie. Otherwise, it needs to be created from the octets via from_octets. Similarly, the Default implementation will create a random cookie and is thus only available if the rand feature is enabled.

Implementations

impl ClientCookie

pub const fn from_octets(octets: [u8; 8]) -> Self

Creates a new client cookie from the given octets.

pub fn new_random() -> Self

Creates a new random client cookie.

pub fn into_octets(self) -> [u8; 8]

Converts the cookie into its octets.

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

Parses a client cookie from its wire format.

pub const COMPOSE_LEN: u16 = 8u16

The length of the wire format of a client cookie.

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

Appends the wire format of the client cookie to the target.

Trait Implementations

impl AsMut<[u8]> for ClientCookie

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

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

impl AsRef<[u8]> for ClientCookie

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

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

impl Clone for ClientCookie

fn clone(&self) -> ClientCookie

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientCookie

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

Formats the value using the given formatter.

impl Default for ClientCookie

fn default() -> Self

Returns the “default value” for a type.

impl Display for ClientCookie

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

Formats the value using the given formatter.

impl From<[u8; 8]> for ClientCookie

fn from(src: [u8; 8]) -> Self

Converts to this type from the input type.

impl From<ClientCookie> for [u8; 8]

fn from(src: ClientCookie) -> Self

Converts to this type from the input type.

impl Hash for ClientCookie

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 Ord for ClientCookie

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

Restrict a value to a certain interval.

impl PartialEq for ClientCookie

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ClientCookie

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for ClientCookie

impl Eq for ClientCookie

impl StructuralPartialEq for ClientCookie