Struct nex_packet::dns::DnsPacket

pub struct DnsPacket<'p> { /* private fields */ }

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> DnsPacket<'a>

pub fn new<'p>(packet: &'p [u8]) -> Option<DnsPacket<'p>>

Constructs a new DnsPacket. If the provided buffer is less than the minimum required packet size, this will return None.

pub fn owned(packet: Vec<u8>) -> Option<DnsPacket<'static>>

Constructs a new DnsPacket. If the provided buffer is less than the minimum required packet size, this will return None. With this constructor the DnsPacket will own its own data and the underlying buffer will be dropped when the DnsPacket is.

pub fn to_immutable<'p>(&'p self) -> DnsPacket<'p>

Maps from a DnsPacket to a DnsPacket

pub fn consume_to_immutable(self) -> DnsPacket<'a>

Maps from a DnsPacket to a DnsPacket while consuming the source

pub const fn minimum_packet_size() -> usize

The minimum size (in bytes) a packet of this type can be. It’s based on the total size of the fixed-size fields.

pub fn packet_size(_packet: &Dns) -> usize

The size (in bytes) of a Dns instance when converted into a byte-array

pub fn get_id(&self) -> u16be

Get the id field. This field is always stored big-endian within the struct, but this accessor returns host order.

pub fn get_is_response(&self) -> u1

Get the is_response field.

pub fn get_opcode(&self) -> OpCode

Get the value of the opcode field

pub fn get_is_authoriative(&self) -> u1

Get the is_authoriative field.

pub fn get_is_truncated(&self) -> u1

Get the is_truncated field.

pub fn get_is_recursion_desirable(&self) -> u1

Get the is_recursion_desirable field.

pub fn get_is_recursion_available(&self) -> u1

Get the is_recursion_available field.

pub fn get_zero_reserved(&self) -> u1

Get the zero_reserved field.

pub fn get_is_answer_authenticated(&self) -> u1

Get the is_answer_authenticated field.

pub fn get_is_non_authenticated_data(&self) -> u1

Get the is_non_authenticated_data field.

pub fn get_rcode(&self) -> RetCode

Get the value of the rcode field

pub fn get_query_count(&self) -> u16be

Get the query_count field. This field is always stored big-endian within the struct, but this accessor returns host order.

pub fn get_response_count(&self) -> u16be

Get the response_count field. This field is always stored big-endian within the struct, but this accessor returns host order.

pub fn get_authority_rr_count(&self) -> u16be

Get the authority_rr_count field. This field is always stored big-endian within the struct, but this accessor returns host order.

pub fn get_additional_rr_count(&self) -> u16be

Get the additional_rr_count field. This field is always stored big-endian within the struct, but this accessor returns host order.

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

Get the raw &u8 value of the queries field, without copying

pub fn get_queries(&self) -> Vec<DnsQuery>

Get the value of the queries field (copies contents)

pub fn get_queries_iter(&self) -> DnsQueryIterable<'_>

Get the value of the queries field as iterator

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

Get the raw &u8 value of the responses field, without copying

pub fn get_responses(&self) -> Vec<DnsResponse>

Get the value of the responses field (copies contents)

pub fn get_responses_iter(&self) -> DnsResponseIterable<'_>

Get the value of the responses field as iterator

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

Get the raw &u8 value of the authorities field, without copying

pub fn get_authorities(&self) -> Vec<DnsResponse>

Get the value of the authorities field (copies contents)

pub fn get_authorities_iter(&self) -> DnsResponseIterable<'_>

Get the value of the authorities field as iterator

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

Get the raw &u8 value of the additionals field, without copying

pub fn get_additionals(&self) -> Vec<DnsResponse>

Get the value of the additionals field (copies contents)

pub fn get_additionals_iter(&self) -> DnsResponseIterable<'_>

Get the value of the additionals field as iterator

Trait Implementations

impl<'p> Debug for DnsPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for DnsPacket<'p>

type T = Dns

The type of the packet to convert from.

fn from_packet(&self) -> Dns

Converts a wire-format packet to #[packet] struct format.

impl<'a> Packet for DnsPacket<'a>

fn packet<'p>(&'p self) -> &'p [u8]

Retrieve the underlying buffer for the packet.

fn payload<'p>(&'p self) -> &'p [u8]

Retrieve the payload for the packet.

impl<'a> PacketSize for DnsPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for DnsPacket<'p>

fn eq(&self, other: &DnsPacket<'p>) -> 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<'p> StructuralPartialEq for DnsPacket<'p>