Struct BaseFixedString 

pub struct BaseFixedString<C, const N: usize>
where
    C: BinRead + BinWrite + Copy + Clone + Default + 'static + Sized,
    for<'a> <C as BinRead>::Args<'a>: Default + Clone,
    for<'b> <C as BinWrite>::Args<'b>: Default + Clone,
{ /* private fields */ }

Fixed-size string with a specified character type and length.

The string always takes up exactly N characters, with unused characters filled with default values of the character type.

Notes:

• From<&str> trims or pads the string to fit exactly N characters.
• TryInto<String> only pads with default values, it does not trim.

Implementations

impl<C, const N: usize> BaseFixedString<C, N>

where C: BinRead + BinWrite + Copy + Clone + Default + 'static + Sized, for<'a> <C as BinRead>::Args<'a>: Default + Clone, for<'b> <C as BinWrite>::Args<'b>: Default + Clone,

pub const SIZE_BYTES: usize

The size of the FixedString in memory, in bytes.

This is also it’s size when bin-read or bin-written.

pub const MAX_CHARS: usize = N

The maximum number of characters in the FixedString.

This is the very same as the generic const parameter N.

pub fn from_slice(slice: &[C]) -> Self

Creates a new FixedString from a slice.

If the slice is shorter than N, the remaining bytes are filled with default values. If the slice is longer than N, it is truncated.

pub fn as_slice(&self) -> &[C]

Returns the inner data as a slice.

Trait Implementations

impl<C, const N: usize> BinRead for BaseFixedString<C, N>

where C: BinRead + BinWrite + Copy + Clone + Default + 'static + Sized, for<'a> <C as BinRead>::Args<'a>: Default + Clone, for<'b> <C as BinWrite>::Args<'b>: Default + Clone,

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of read_args() and read_options().

fn read_options<R: Read + Seek>( __binrw_generated_var_reader: &mut R, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<Self>

Read Self from the reader using the given Endian and arguments.

fn read_be<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming big-endian byte order.

fn read_le<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming little-endian byte order.

fn read_ne<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read T from the reader assuming native-endian byte order.

fn read_be_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming big-endian byte order, using the given arguments.

fn read_le_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming little-endian byte order, using the given arguments.

fn read_ne_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read T from the reader, assuming native-endian byte order, using the given arguments.

impl<C, const N: usize> BinWrite for BaseFixedString<C, N>

where C: BinRead + BinWrite + Copy + Clone + Default + 'static + Sized, for<'a> <C as BinRead>::Args<'a>: Default + Clone, for<'b> <C as BinWrite>::Args<'b>: Default + Clone,

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of write_args() and write_options().

fn write_options<W: Write + Seek>( &self, __binrw_generated_var_writer: &mut W, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<()>

Write Self to the writer using the given Endian and arguments.

fn write_be<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming big-endian byte order.

fn write_le<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming little-endian byte order.

fn write_ne<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming native-endian byte order.

fn write_be_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming big-endian byte order, using the given arguments.

fn write_le_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming little-endian byte order, using the given arguments.

fn write_ne_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming native-endian byte order, using the given arguments.

impl<C, const N: usize> Clone for BaseFixedString<C, N>

where C: BinRead + BinWrite + Copy + Clone + Default + 'static + Clone + Sized, for<'a> <C as BinRead>::Args<'a>: Default + Clone, for<'b> <C as BinWrite>::Args<'b>: Default + Clone,

fn clone(&self) -> BaseFixedString<C, N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C, const N: usize> Debug for BaseFixedString<C, N>

where C: BinRead + BinWrite + Copy + Clone + Default + 'static + Debug + Sized, for<'a> <C as BinRead>::Args<'a>: Default + Clone, for<'b> <C as BinWrite>::Args<'b>: Default + Clone,

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

Formats the value using the given formatter.

impl<C, const N: usize> Default for BaseFixedString<C, N>

where C: BinRead + BinWrite + Copy + Clone + Default + 'static + Sized, for<'a> <C as BinRead>::Args<'a>: Default + Clone, for<'b> <C as BinWrite>::Args<'b>: Default + Clone,

fn default() -> Self

Returns the “default value” for a type.

impl<const N: usize> FromStr for BaseFixedString<u16, N>

type Err = &'static str

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<const N: usize> FromStr for BaseFixedString<u8, N>

type Err = &'static str

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<C, const N: usize> PartialEq for BaseFixedString<C, N>

where C: BinRead + BinWrite + Copy + Clone + Default + 'static + PartialEq + Sized, for<'a> <C as BinRead>::Args<'a>: Default + Clone, for<'b> <C as BinWrite>::Args<'b>: Default + Clone,

fn eq(&self, other: &BaseFixedString<C, N>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<C, const N: usize> Eq for BaseFixedString<C, N>

where C: BinRead + BinWrite + Copy + Clone + Default + 'static + Eq + Sized, for<'a> <C as BinRead>::Args<'a>: Default + Clone, for<'b> <C as BinWrite>::Args<'b>: Default + Clone,

impl<C, const N: usize> StructuralPartialEq for BaseFixedString<C, N>

where C: BinRead + BinWrite + Copy + Clone + Default + 'static + Sized, for<'a> <C as BinRead>::Args<'a>: Default + Clone, for<'b> <C as BinWrite>::Args<'b>: Default + Clone,