Struct trust_dns_proto::serialize::binary::BinDecoder

source ·
pub struct BinDecoder<'a> { /* private fields */ }
Expand description

This is non-destructive to the inner buffer, b/c for pointer types we need to perform a reverse seek to lookup names

A note on serialization, there was a thought to have this implement the Serde deserializer, but given that this is such a small subset of all the serialization which that performs this is a simpler implementation without the cruft, at least for serializing to/from the binary DNS protocols.

Implementations§

source§

impl<'a> BinDecoder<'a>

source

pub fn new(buffer: &'a [u8]) -> Self

Creates a new BinDecoder

§Arguments
  • buffer - buffer from which all data will be read
source

pub fn pop(&mut self) -> Result<Restrict<u8>, DecodeError>

Pop one byte from the buffer

source

pub fn len(&self) -> usize

Returns the number of bytes in the buffer

use trust_dns_proto::serialize::binary::BinDecoder;

let deadbeef = b"deadbeef";
let mut decoder = BinDecoder::new(deadbeef);
assert_eq!(decoder.len(), 8);
decoder.read_slice(7).unwrap();
assert_eq!(decoder.len(), 1);
source

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty

source

pub fn peek(&self) -> Option<Restrict<u8>>

Peed one byte forward, without moving the current index forward

source

pub fn index(&self) -> usize

Returns the current index in the buffer

source

pub fn clone(&self, index_at: u16) -> BinDecoder<'a>

This is a pretty efficient clone, as the buffer is never cloned, and only the index is set to the value passed in

source

pub fn read_character_data(&mut self) -> Result<Restrict<&[u8]>, DecodeError>

Reads a String from the buffer

<character-string> is a single
length octet followed by that number of characters.  <character-string>
is treated as binary information, and can be up to 256 characters in
length (including the length octet).
§Returns

A String version of the character data

source

pub fn read_vec(&mut self, len: usize) -> Result<Restrict<Vec<u8>>, DecodeError>

Reads a Vec out of the buffer

§Arguments
  • len - number of bytes to read from the buffer
§Returns

The Vec of the specified length, otherwise an error

source

pub fn read_slice( &mut self, len: usize, ) -> Result<Restrict<&'a [u8]>, DecodeError>

Reads a slice out of the buffer, without allocating

§Arguments
  • len - number of bytes to read from the buffer
§Returns

The slice of the specified length, otherwise an error

source

pub fn slice_from(&self, index: usize) -> Result<&'a [u8], DecodeError>

Reads a slice from a previous index to the current

source

pub fn read_u8(&mut self) -> Result<Restrict<u8>, DecodeError>

Reads a byte from the buffer, equivalent to Self::pop()

source

pub fn read_u16(&mut self) -> Result<Restrict<u16>, DecodeError>

Reads the next 2 bytes into u16

This performs a byte-by-byte manipulation, there which means endianness is implicitly handled (i.e. no network to little endian (intel), issues)

§Return

Return the u16 from the buffer

source

pub fn read_i32(&mut self) -> Result<Restrict<i32>, DecodeError>

Reads the next four bytes into i32.

This performs a byte-by-byte manipulation, there which means endianness is implicitly handled (i.e. no network to little endian (intel), issues)

§Return

Return the i32 from the buffer

source

pub fn read_u32(&mut self) -> Result<Restrict<u32>, DecodeError>

Reads the next four bytes into u32.

This performs a byte-by-byte manipulation, there which means endianness is implicitly handled (i.e. no network to little endian (intel), issues)

§Return

Return the u32 from the buffer

Auto Trait Implementations§

§

impl<'a> Freeze for BinDecoder<'a>

§

impl<'a> RefUnwindSafe for BinDecoder<'a>

§

impl<'a> Send for BinDecoder<'a>

§

impl<'a> Sync for BinDecoder<'a>

§

impl<'a> Unpin for BinDecoder<'a>

§

impl<'a> UnwindSafe for BinDecoder<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more