Struct stun_codec::MessageEncoder

source · [−]

pub struct MessageEncoder<A: Attribute> { /* private fields */ }

Expand description

Message encoder.

Implementations

source

impl<A: Attribute> MessageEncoder<A>

source

pub fn new() -> Self

Makes a new MessageEncoder instance.

Trait Implementations

source

impl<A: Debug + Attribute> Debug for MessageEncoder<A>

source

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

Formats the value using the given formatter. Read more

source

impl<A: Attribute> Default for MessageEncoder<A>

source

fn default() -> Self

Returns the “default value” for a type. Read more

source

impl<A: Attribute> Encode for MessageEncoder<A>

type Item = Message<A>

The type of items to be encoded.

source

fn encode(&mut self, buf: &mut [u8 ], eos: Eos) -> Result<usize>

Encodes the items in the encoder and writes the encoded bytes to the given buffer. Read more

source

fn start_encoding(&mut self, item: Self::Item) -> Result<()>

Tries to start encoding the given item. Read more

source

fn requiring_bytes(&self) -> ByteCount

Returns the number of bytes required to encode all the items in the encoder. Read more

source

fn is_idle(&self) -> bool

Returns true if there are no items to be encoded in the encoder, otherwise false. Read more

source

impl<A: Attribute> SizedEncode for MessageEncoder<A>

source

fn exact_requiring_bytes(&self) -> u64

Returns the exact number of bytes required to encode all the items remaining in the encoder.

Auto Trait Implementations

impl<A> RefUnwindSafe for MessageEncoder<A> where
A: RefUnwindSafe,
<A as Attribute>::Encoder: RefUnwindSafe,

impl<A> Send for MessageEncoder<A> where
A: Send,
<A as Attribute>::Encoder: Send,

impl<A> Sync for MessageEncoder<A> where
A: Sync,
<A as Attribute>::Encoder: Sync,

impl<A> Unpin for MessageEncoder<A> where
A: Unpin,
<A as Attribute>::Encoder: Unpin,

impl<A> UnwindSafe for MessageEncoder<A> where
A: UnwindSafe + RefUnwindSafe,
<A as Attribute>::Encoder: 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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> EncodeExt for T where
T: Encode,

source

fn with_item(item: Self::Item) -> Result<Self, Error> where
Self: Default,

Creates a new encoder instance that has the given initial item. Read more

source

fn map_err<E, F>(self, f: F) -> MapErr<Self, E, F> where
F: Fn(Error) -> E,
Error: From<E>,

Creates an encoder for modifying encoding errors produced by self. Read more

source

fn map_from<T, F>(self, f: F) -> MapFrom<Self, T, F> where
F: Fn(T) -> Self::Item,

Creates an encoder that converts items into ones that suited to the self encoder by calling the given function. Read more

source

fn try_map_from<T, E, F>(self, f: F) -> TryMapFrom<Self, T, E, F> where
F: Fn(T) -> Result<Self::Item, E>,
Error: From<E>,

Creates an encoder that tries to convert items into ones that suited to the self encoder by calling the given function. Read more

source

fn optional(self) -> Optional<Self>

Creates an encoder that represents an optional encoder. Read more

source

fn max_bytes(self, n: u64) -> MaxBytes<Self>

Creates an encoder that will fail if the number of encoded bytes of an item exceeds n. Read more

source

fn length(self, n: u64) -> Length<Self>

Creates an encoder that required to encode each item exactly at the specified number of bytes. Read more

source

fn chain<T>(self, other: T) -> TupleEncoder<(Self, T)> where
T: Encode,

Takes two encoders and creates a new encoder that encodes both items in sequence. Read more

source

fn repeat(self) -> Repeat<Self, I> where
I: Iterator<Item = Self::Item>,

Creates an encoder that repeats encoding of Self::Item. Read more

source

fn pre_encode(self) -> PreEncode<Self>

Creates an encoder that pre-encodes items when start_encoding method is called. Read more

source

fn slice(self) -> Slice<Self>

Creates an encoder that makes it possible to slice the encoded byte sequence in arbitrary units. Read more

source

fn last(self, item: Self::Item) -> Last<Self>

Creates an encoder that cannot accept any more items except the given one.

source

fn encode_into_bytes(
&mut self,
item: Self::Item
) -> Result<Vec<u8, Global>, Error>

Encodes the given item and returns the resulting bytes. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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> IoEncodeExt for T where
T: Encode,

source

fn encode_to_write_buf(&mut self, buf: &mut WriteBuf) -> Result<(), Error> where
B: AsMut<[u8 ]>,

Encodes the items remaining in the encoder and writes the encoded bytes to the given write buffer. Read more

source

fn encode_all<W>(&mut self, writer: W) -> Result<(), Error> where
W: Write,

Encodes all of the items remaining in the encoder and writes the encoded bytes to the given writer. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct stun_codec::MessageEncoder

Implementations

impl<A: Attribute> MessageEncoder<A>

pub fn new() -> Self

Trait Implementations

impl<A: Debug + Attribute> Debug for MessageEncoder<A>

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

impl<A: Attribute> Default for MessageEncoder<A>

fn default() -> Self

impl<A: Attribute> Encode for MessageEncoder<A>

type Item = Message<A>

fn encode(&mut self, buf: &mut [u8], eos: Eos) -> Result<usize>

fn start_encoding(&mut self, item: Self::Item) -> Result<()>

fn requiring_bytes(&self) -> ByteCount

fn is_idle(&self) -> bool

impl<A: Attribute> SizedEncode for MessageEncoder<A>

fn exact_requiring_bytes(&self) -> u64

Auto Trait Implementations

impl<A> RefUnwindSafe for MessageEncoder<A> where A: RefUnwindSafe, <A as Attribute>::Encoder: RefUnwindSafe,

impl<A> Send for MessageEncoder<A> where A: Send, <A as Attribute>::Encoder: Send,

impl<A> Sync for MessageEncoder<A> where A: Sync, <A as Attribute>::Encoder: Sync,

impl<A> Unpin for MessageEncoder<A> where A: Unpin, <A as Attribute>::Encoder: Unpin,

impl<A> UnwindSafe for MessageEncoder<A> where A: UnwindSafe + RefUnwindSafe, <A as Attribute>::Encoder: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> EncodeExt for T where T: Encode,

fn with_item(item: Self::Item) -> Result<Self, Error> where Self: Default,

fn map_err<E, F>(self, f: F) -> MapErr<Self, E, F> where F: Fn(Error) -> E, Error: From<E>,

fn map_from<T, F>(self, f: F) -> MapFrom<Self, T, F> where F: Fn(T) -> Self::Item,

fn try_map_from<T, E, F>(self, f: F) -> TryMapFrom<Self, T, E, F> where F: Fn(T) -> Result<Self::Item, E>, Error: From<E>,

fn optional(self) -> Optional<Self>

fn max_bytes(self, n: u64) -> MaxBytes<Self>

fn length(self, n: u64) -> Length<Self>

fn chain<T>(self, other: T) -> TupleEncoder<(Self, T)> where T: Encode,

fn repeat<I>(self) -> Repeat<Self, I> where I: Iterator<Item = Self::Item>,

fn pre_encode(self) -> PreEncode<Self>

fn slice(self) -> Slice<Self>

fn last(self, item: Self::Item) -> Last<Self>

fn encode_into_bytes( &mut self, item: Self::Item) -> Result<Vec<u8, Global>, Error>

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> IoEncodeExt for T where T: Encode,

fn encode_to_write_buf<B>(&mut self, buf: &mut WriteBuf<B>) -> Result<(), Error> where B: AsMut<[u8]>,

fn encode_all<W>(&mut self, writer: W) -> Result<(), Error> where W: Write,

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

type Error = Infallible

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

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

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

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

fn encode(&mut self, buf: &mut [u8 ], eos: Eos) -> Result<usize>

impl<A> RefUnwindSafe for MessageEncoder<A> where
A: RefUnwindSafe,
<A as Attribute>::Encoder: RefUnwindSafe,

impl<A> Send for MessageEncoder<A> where
A: Send,
<A as Attribute>::Encoder: Send,

impl<A> Sync for MessageEncoder<A> where
A: Sync,
<A as Attribute>::Encoder: Sync,

impl<A> Unpin for MessageEncoder<A> where
A: Unpin,
<A as Attribute>::Encoder: Unpin,

impl<A> UnwindSafe for MessageEncoder<A> where
A: UnwindSafe + RefUnwindSafe,
<A as Attribute>::Encoder: UnwindSafe,

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

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

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

impl<T> EncodeExt for T where
T: Encode,

fn with_item(item: Self::Item) -> Result<Self, Error> where
Self: Default,

fn map_err<E, F>(self, f: F) -> MapErr<Self, E, F> where
F: Fn(Error) -> E,
Error: From<E>,

fn map_from<T, F>(self, f: F) -> MapFrom<Self, T, F> where
F: Fn(T) -> Self::Item,

fn try_map_from<T, E, F>(self, f: F) -> TryMapFrom<Self, T, E, F> where
F: Fn(T) -> Result<Self::Item, E>,
Error: From<E>,

fn chain<T>(self, other: T) -> TupleEncoder<(Self, T)> where
T: Encode,

fn repeat<I>(self) -> Repeat<Self, I> where
I: Iterator<Item = Self::Item>,

fn encode_into_bytes(
&mut self,
item: Self::Item
) -> Result<Vec<u8, Global>, Error>

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

impl<T> IoEncodeExt for T where
T: Encode,

fn encode_to_write_buf<B>(&mut self, buf: &mut WriteBuf<B>) -> Result<(), Error> where
B: AsMut<[u8 ]>,

fn encode_all<W>(&mut self, writer: W) -> Result<(), Error> where
W: Write,

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

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