HeaplessCStringCodec

Struct HeaplessCStringCodec 

Source
pub struct HeaplessCStringCodec<const N: usize>;
Expand description

A codec for heapless C-style null-terminated strings.

§Examples

use byten::{HeaplessCStringCodec, Encoder, Decoder, Measurer, EncoderToVec as _};

let s: heapless::CString<32> = heapless::CString::from_bytes_with_nul(b"Hello, world!\0").unwrap();
let codec = HeaplessCStringCodec::<32>::new();

let encoded = codec.encode_to_heapless_vec::<32>(&s).unwrap();
assert_eq!(encoded.as_slice(), b"Hello, world!\0");

let mut decode_offset = 0;
let decoded: heapless::CString<32> = codec.decode(&encoded, &mut decode_offset).unwrap();
assert_eq!(decoded, s);
assert_eq!(decode_offset, encoded.len());

let size = codec.measure(&s).unwrap();
assert_eq!(size, encoded.len());

Implementations§

Source§

impl<const N: usize> HeaplessCStringCodec<N>

Source

pub const fn new() -> Self

Trait Implementations§

Source§

impl<'encoded, 'decoded, const N: usize> Decoder<'encoded, 'decoded> for HeaplessCStringCodec<N>
where 'encoded: 'decoded,

Source§

type Decoded = CString<N>

Source§

fn decode( &self, encoded: &'encoded [u8], offset: &mut usize, ) -> Result<Self::Decoded, DecodeError>

Source§

impl<const N: usize> Encoder for HeaplessCStringCodec<N>

Source§

type Decoded = CString<N>

Source§

fn encode( &self, decoded: &Self::Decoded, encoded: &mut [u8], offset: &mut usize, ) -> Result<(), EncodeError>

Source§

impl<const N: usize> Measurer for HeaplessCStringCodec<N>

Source§

type Decoded = CString<N>

Source§

fn measure(&self, decoded: &Self::Decoded) -> Result<usize, EncodeError>

Auto Trait Implementations§

§

impl<const N: usize> Freeze for HeaplessCStringCodec<N>

§

impl<const N: usize> RefUnwindSafe for HeaplessCStringCodec<N>

§

impl<const N: usize> Send for HeaplessCStringCodec<N>

§

impl<const N: usize> Sync for HeaplessCStringCodec<N>

§

impl<const N: usize> Unpin for HeaplessCStringCodec<N>

§

impl<const N: usize> UnwindSafe for HeaplessCStringCodec<N>

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<Decoded, C> EncoderToVec for C
where C: Encoder<Decoded = Decoded> + Measurer<Decoded = Decoded>, Decoded: ?Sized,

Source§

type Decoded = Decoded

Source§

fn encode_to_vec( &self, decoded: &<C as EncoderToVec>::Decoded, ) -> Result<Vec<u8>, EncodeError>

Source§

fn encode_to_heapless_vec<const N: usize>( &self, decoded: &<C as EncoderToVec>::Decoded, ) -> Result<VecInner<u8, usize, VecStorageInner<[MaybeUninit<u8>; N]>>, EncodeError>

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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>,

Source§

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>,

Source§

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.