Struct domain::base::message_builder::StreamTarget

source ·
pub struct StreamTarget<Target> { /* private fields */ }
Expand description

A builder target for sending messages on stream transports.

When messages are sent over stream-oriented transports such as TCP, a DNS message is preceded by a 16 bit length value in order to determine the end of a message. This type transparently adds this length value as the first two octets of an octets builder and itself presents an octets builder interface for building the actual message. Whenever data is pushed to that builder interface, the type will update the length value.

Because the length is 16 bits long, the assembled message can be at most 65536 octets long, independently of the maximum length the underlying builder allows.

Implementations§

source§

impl<Target: Composer> StreamTarget<Target>

source

pub fn new(target: Target) -> Result<Self, Target::AppendError>

Creates a new stream target wrapping an octets builder.

The function will truncate the builder back to empty and append the length value. Because of the latter, this can fail if the octets builder doesn’t even have space for that.

source§

impl StreamTarget<Vec<u8>>

source

pub fn new_vec() -> Self

Creates a stream target atop an empty Vec<u8>.

source§

impl StreamTarget<BytesMut>

source

pub fn new_bytes() -> Self

Creates a stream target atop an empty Vec<u8>.

source§

impl<Target> StreamTarget<Target>

source

pub fn as_target(&self) -> &Target

Returns a reference to the underlying octets builder.

source

pub fn into_target(self) -> Target

Converts the stream target into the underlying octets builder.

The returned builder will contain the 16 bit length value with the correct content and the assembled message.

source§

impl<Target: AsRef<[u8]>> StreamTarget<Target>

source

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

Returns an octets slice of the message for stream transports.

The slice will start with the length octets and can be send as is through a stream transport such as TCP.

source

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

Returns an octets slice of the message for datagram transports.

The slice will not contain the length octets but only the actual message itself. This slice can be used for sending via datagram transports such as UDP.

Trait Implementations§

source§

impl<Target: AsMut<[u8]>> AsMut<[u8]> for StreamTarget<Target>

source§

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

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

impl<Target: AsRef<[u8]>> AsRef<[u8]> for StreamTarget<Target>

source§

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

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

impl<Target: Clone> Clone for StreamTarget<Target>

source§

fn clone(&self) -> StreamTarget<Target>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<Target> Composer for StreamTarget<Target>
where Target: Composer, Target::AppendError: Into<ShortBuf>,

source§

fn append_compressed_dname<N: ToDname + ?Sized>( &mut self, name: &N, ) -> Result<(), Self::AppendError>

Appends a domain name using name compression if supported. Read more
source§

fn can_compress(&self) -> bool

source§

impl<Target: Debug> Debug for StreamTarget<Target>

source§

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

Formats the value using the given formatter. Read more
source§

impl<Target> OctetsBuilder for StreamTarget<Target>
where Target: OctetsBuilder + AsRef<[u8]> + AsMut<[u8]>, Target::AppendError: Into<ShortBuf>,

§

type AppendError = ShortBuf

The error type when appending data fails. Read more
source§

fn append_slice(&mut self, slice: &[u8]) -> Result<(), Self::AppendError>

Appends the content of a slice to the builder. Read more
source§

impl<Target: Composer> Truncate for StreamTarget<Target>

source§

fn truncate(&mut self, len: usize)

Truncate the sequence to len octets. Read more

Auto Trait Implementations§

§

impl<Target> Freeze for StreamTarget<Target>
where Target: Freeze,

§

impl<Target> RefUnwindSafe for StreamTarget<Target>
where Target: RefUnwindSafe,

§

impl<Target> Send for StreamTarget<Target>
where Target: Send,

§

impl<Target> Sync for StreamTarget<Target>
where Target: Sync,

§

impl<Target> Unpin for StreamTarget<Target>
where Target: Unpin,

§

impl<Target> UnwindSafe for StreamTarget<Target>
where Target: UnwindSafe,

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> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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<Source, Target> OctetsInto<Target> for Source
where Target: OctetsFrom<Source>,

§

type Error = <Target as OctetsFrom<Source>>::Error

source§

fn try_octets_into( self, ) -> Result<Target, <Source as OctetsInto<Target>>::Error>

Performs the conversion.
source§

fn octets_into(self) -> Target
where Self::Error: Into<Infallible>,

Performs an infallible conversion.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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