Struct simple_dns::PacketBuf

pub struct PacketBuf { /* fields omitted */ }

Owned version of Packet that contains a internal buffer.
This struct fills the internal buffer on the fly, because of this, it imposes some constraints.
You have to build the packet in order.
ex: It is not possible to add a question after an answer

Implementations

impl PacketBuf

pub fn new(header: PacketHeader, compression: bool) -> Self

Creates a new empty PacketBuf

pub fn new_query(compression: bool) -> Self

Creates a new empty PacketBuf with a query header

pub fn add_question(&mut self, question: &Question<'_>) -> Result<()>

Add a Question to this packet.
This function will fail if the packet already has any answer, name server or additional records

pub fn add_answer(&mut self, answer: &ResourceRecord<'_>) -> Result<()>

Add a Answer to this packet.
This function will fail if the packet already has any name server or additional records

pub fn add_name_server(
    &mut self,
    name_server: &ResourceRecord<'_>
) -> Result<()>

Add a Name Server to this packet.
This function will fail if the packet already has any additional records

pub fn add_additional_record(
    &mut self,
    additional_record: &ResourceRecord<'_>
) -> Result<()>

Add an Additional Record to this packet

pub fn packet_id(&self) -> u16

Return the packet id from this packet header

pub fn to_packet(&self) -> Result<Packet<'_>>

Creates a Packet by calling the Packet::parse function

pub fn has_answers(&self) -> bool

Return true if this packet has any answers

pub fn has_questions(&self) -> bool

Return true if this packet has questions

pub fn has_name_servers(&self) -> bool

Return true if this packet has any name servers

pub fn has_additional_records(&self) -> bool

Return true if this packet has any additional records

pub fn questions_iter(&self) -> QuestionsIter<'_>

Returns an Iterator over questions of this packet

Methods from Deref<Target = Vec<u8>>

pub fn capacity(&self) -> usize

Returns the number of elements the vector can hold without reallocating.

Examples

let vec: Vec<i32> = Vec::with_capacity(10);
assert_eq!(vec.capacity(), 10);

pub fn as_slice(&self) -> &[T]

Extracts a slice containing the entire vector.

Equivalent to &s[..].

Examples

use std::io::{self, Write};
let buffer = vec![1, 2, 3, 5, 8];
io::sink().write(buffer.as_slice()).unwrap();

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

Returns a raw pointer to the vector’s buffer.

The caller must ensure that the vector outlives the pointer this function returns, or else it will end up pointing to garbage. Modifying the vector may cause its buffer to be reallocated, which would also make any pointers to it invalid.

The caller must also ensure that the memory the pointer (non-transitively) points to is never written to (except inside an UnsafeCell) using this pointer or any pointer derived from it. If you need to mutate the contents of the slice, use as_mut_ptr.

Examples

let x = vec![1, 2, 4];
let x_ptr = x.as_ptr();

unsafe {
    for i in 0..x.len() {
        assert_eq!(*x_ptr.add(i), 1 << i);
    }
}

pub fn allocator(&self) -> &A

🔬 This is a nightly-only experimental API. (allocator_api)

Returns a reference to the underlying allocator.

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its ‘length’.

Examples

let a = vec![1, 2, 3];
assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

Examples

let mut v = Vec::new();
assert!(v.is_empty());

v.push(1);
assert!(!v.is_empty());

Trait Implementations

impl Deref for PacketBuf

type Target = Vec<u8>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<&'_ [u8]> for PacketBuf

fn from(buffer: &[u8]) -> Self

Performs the conversion.