StringAsciiFixed

Struct StringAsciiFixed 

Source
pub struct StringAsciiFixed<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool>(/* private fields */);
Expand description

A string of ascii characters, padded with a constant byte, allocated on stack using [u8; LEN]

use ::byteserde_types::prelude::*;

// Takes [u8; 5] array, which `exact` capacity as [StringAsciiFixed], compile time check on capacity
let inp_str: StringAsciiFixed<5, 0x20, false> = b"ABCDE".into();
println!("{:x}", inp_str);
assert_eq!(inp_str.bytes(), [0x41, 0x42, 0x43, 0x44, 0x45]);

// Takes `only` 5 bytes no alignment effect or padding due capacity.
let inp_str: StringAsciiFixed<5, 0x20, false> = b"ABCDEFG".as_slice().into();
println!("{:x}", inp_str);
assert_eq!(inp_str.bytes(), [0x41, 0x42, 0x43, 0x44, 0x45]);

// Takes `only` 5 bytes no alignment effect or padding due capacity.
let inp_str: StringAsciiFixed<5, 0x20, true> = b"ABCDEFG".as_slice().into();
println!("{:x}", inp_str);
assert_eq!(inp_str.bytes(), [0x41, 0x42, 0x43, 0x44, 0x45]);

// Takes `all` 4 bytes and aligns to the LEFT, while padding with SPACE
let inp_str: StringAsciiFixed<5, 0x20, false> = b"ABCD".as_slice().into();
println!("{:x}", inp_str);
assert_eq!(inp_str.bytes(), [0x41, 0x42, 0x43, 0x44, 0x20]);

// Takes `all` 4 bytes and aligns to the RIGHT, while padding with SPACE
let inp_str: StringAsciiFixed<5, 0x20, true> = b"ABCD".as_slice().into();
println!("{:x}", inp_str);
assert_eq!(inp_str.bytes(), [0x20, 0x41, 0x42, 0x43, 0x44]);

Implementations§

Source§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

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

Trait Implementations§

Source§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> ByteDeserializeSlice<StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>> for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Source§

fn byte_deserialize( des: &mut ByteDeserializerSlice<'_>, ) -> Result<StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>>

If successful returns a new instance of T type struct, depleting exactly the right amount of bytes from ByteDeserializerSlice Number of bytes depleted is determined by the struct T itself and its member types.
Source§

fn byte_deserialize_take( des: &mut ByteDeserializerSlice<'_>, len: usize, ) -> Result<T, SerDesError>

if successful returns a new instance of T type struct, however ONLY depleting a maximum of len bytes from ByteDeserializerSlice Intended for types with variable length such as Strings, Vec, etc. No bytes will be depleted if attempt was not successful.
Source§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> ByteSerializeHeap for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Source§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> ByteSerializeStack for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Source§

fn byte_serialize_stack<const CAP: usize>( &self, ser: &mut ByteSerializerStack<CAP>, ) -> Result<()>

Source§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> ByteSerializedLenOf for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Source§

fn byte_len(&self) -> usize

Source§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> Clone for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Source§

fn clone(&self) -> StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Returns a duplicate 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<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> Debug for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Source§

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

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

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> Default for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Source§

fn default() -> Self

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

impl<'de, const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> Deserialize<'de> for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Source§

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> Display for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Source§

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

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

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> From<&[u8]> for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Source§

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

Runt time check for capacity, Takes defensively and up to LEN, never overflows.

Source§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> From<&[u8; LEN]> for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Source§

fn from(bytes: &[u8; LEN]) -> Self

Compiler time check for capacity, bytes array must be same length as LEN

Source§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> From<u16> for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Source§

fn from(value: u16) -> Self

Converts to this type from the input type.
Source§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> From<u32> for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Source§

fn from(value: u32) -> Self

Converts to this type from the input type.
Source§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> From<u64> for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Source§

fn from(value: u64) -> Self

Converts to this type from the input type.
Source§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> LowerHex for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Source§

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

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

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> PartialEq for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Source§

fn eq(&self, other: &StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> Serialize for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Source§

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer. Read more
Source§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> StructuralPartialEq for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

Auto Trait Implementations§

§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> Freeze for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> RefUnwindSafe for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> Send for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> Sync for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> Unpin for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

§

impl<const LEN: usize, const PADDING: u8, const RIGHT_ALIGN: bool> UnwindSafe for StringAsciiFixed<LEN, PADDING, RIGHT_ALIGN>

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§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> ToOwned for T
where T: Clone,

Source§

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,