Struct ByteArray

pub struct ByteArray<const N: usize> { /* private fields */ }

Wrapper around [u8; N] to serialize and deserialize efficiently.

use std::collections::HashMap;
use std::io;

use serde_bytes::ByteArray;

fn deserialize_bytearrays() -> Result<(), bincode::error::DecodeError> {
    let example_data = [2, 2, 3, 116, 119, 111, 1, 3, 111, 110, 101];

    let map: HashMap<u32, ByteArray<3>>;
    (map, _) = bincode::serde::decode_from_slice(
        &example_data,
        bincode::config::standard(),
    )?;

    println!("{:?}", map);

    Ok(())
}

Implementations

impl<const N: usize> ByteArray<N>

pub const fn new(bytes: [u8; N]) -> ByteArray<N>

Wrap an existing array into a ByteArray.

pub const fn into_array(self) -> [u8; N]

Unwrap the byte array underlying this ByteArray.

Methods from Deref<Target = [u8; N]>

pub fn as_ascii(&self) -> Option<&[AsciiChar; N]>

🔬This is a nightly-only experimental API. (ascii_char)

Converts this array of bytes into an array of ASCII characters, or returns None if any of the characters is non-ASCII.

Examples

#![feature(ascii_char)]

const HEX_DIGITS: [std::ascii::Char; 16] =
    *b"0123456789abcdef".as_ascii().unwrap();

assert_eq!(HEX_DIGITS[1].as_str(), "1");
assert_eq!(HEX_DIGITS[10].as_str(), "a");

pub unsafe fn as_ascii_unchecked(&self) -> &[AsciiChar; N]

🔬This is a nightly-only experimental API. (ascii_char)

Converts this array of bytes into an array of ASCII characters, without checking whether they’re valid.

Safety

Every byte in the array must be in 0..=127, or else this is UB.

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

Returns a slice containing the entire array. Equivalent to &s[..].

pub fn as_mut_slice(&mut self) -> &mut [T]

Returns a mutable slice containing the entire array. Equivalent to &mut s[..].

pub fn each_ref(&self) -> [&T; N]

Borrows each element and returns an array of references with the same size as self.

Example

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

pub fn each_mut(&mut self) -> [&mut T; N]

Borrows each element mutably and returns an array of mutable references with the same size as self.

Example

let mut floats = [3.1, 2.7, -1.0];
let float_refs: [&mut f64; 3] = floats.each_mut();
*float_refs[0] = 0.0;
assert_eq!(float_refs, [&mut 0.0, &mut 2.7, &mut -1.0]);
assert_eq!(floats, [0.0, 2.7, -1.0]);

pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.split_array_ref::<0>();
   assert_eq!(left, &[]);
   assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<2>();
    assert_eq!(left, &[1, 2]);
    assert_eq!(right, &[3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<6>();
    assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
    assert_eq!(right, &[]);
}

pub fn split_array_mut<const M: usize>(&mut self) -> (&mut [T; M], &mut [T])

🔬This is a nightly-only experimental API. (split_array)

Divides one mutable array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.split_array_mut::<2>();
assert_eq!(left, &mut [1, 0][..]);
assert_eq!(right, &mut [3, 0, 5, 6]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.rsplit_array_ref::<0>();
   assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
   assert_eq!(right, &[]);
}

{
    let (left, right) = v.rsplit_array_ref::<2>();
    assert_eq!(left, &[1, 2, 3, 4]);
    assert_eq!(right, &[5, 6]);
}

{
    let (left, right) = v.rsplit_array_ref::<6>();
    assert_eq!(left, &[]);
    assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

pub fn rsplit_array_mut<const M: usize>(&mut self) -> (&mut [T], &mut [T; M])

🔬This is a nightly-only experimental API. (split_array)

Divides one mutable array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.rsplit_array_mut::<4>();
assert_eq!(left, &mut [1, 0]);
assert_eq!(right, &mut [3, 0, 5, 6][..]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

Trait Implementations

impl<const N: usize> AsMut<[u8; N]> for ByteArray<N>

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

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

impl<const N: usize> AsRef<[u8; N]> for ByteArray<N>

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

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

impl<const N: usize> Borrow<[u8; N]> for ByteArray<N>

fn borrow(&self) -> &[u8; N]

Immutably borrows from an owned value.

impl<const N: usize> Borrow<Bytes> for ByteArray<N>

fn borrow(&self) -> &Bytes

Immutably borrows from an owned value.

impl<const N: usize> BorrowMut<[u8; N]> for ByteArray<N>

fn borrow_mut(&mut self) -> &mut [u8; N]

Mutably borrows from an owned value.

impl<const N: usize> BorrowMut<Bytes> for ByteArray<N>

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

Mutably borrows from an owned value.

impl<const N: usize> Clone for ByteArray<N>

fn clone(&self) -> ByteArray<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for ByteArray<N>

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

Formats the value using the given formatter.

impl<const N: usize> Default for ByteArray<N>

fn default() -> ByteArray<N>

Returns the “default value” for a type.

impl<const N: usize> Deref for ByteArray<N>

type Target = [u8; N]

The resulting type after dereferencing.

fn deref(&self) -> &<ByteArray<N> as Deref>::Target

Dereferences the value.

impl<const N: usize> DerefMut for ByteArray<N>

fn deref_mut(&mut self) -> &mut <ByteArray<N> as Deref>::Target

Mutably dereferences the value.

impl<'a, 'de, const N: usize> Deserialize<'de> for &'a ByteArray<N>

where 'de: 'a,

fn deserialize<D>( deserializer: D, ) -> Result<&'a ByteArray<N>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de, 'a, const N: usize> Deserialize<'de> for &'a ByteArray<N>

where 'de: 'a,

fn deserialize<D>( deserializer: D, ) -> Result<&'a ByteArray<N>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

impl<'de, const N: usize> Deserialize<'de> for ByteArray<N>

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de, const N: usize> Deserialize<'de> for ByteArray<N>

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

where D: Deserializer<'de>,

impl<const N: usize> From<[u8; N]> for ByteArray<N>

fn from(bytes: [u8; N]) -> ByteArray<N>

Converts to this type from the input type.

impl<const N: usize> Hash for ByteArray<N>

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, const N: usize> IntoIterator for &'a ByteArray<N>

type Item = &'a u8

The type of the elements being iterated over.

type IntoIter = <&'a [u8; N] as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a ByteArray<N> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a, const N: usize> IntoIterator for &'a mut ByteArray<N>

type Item = &'a mut u8

The type of the elements being iterated over.

type IntoIter = <&'a mut [u8; N] as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a mut ByteArray<N> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<const N: usize> IntoIterator for ByteArray<N>

type Item = u8

The type of the elements being iterated over.

type IntoIter = <[u8; N] as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> <ByteArray<N> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<const N: usize> Ord for ByteArray<N>

fn cmp(&self, other: &ByteArray<N>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<Rhs, const N: usize> PartialEq<Rhs> for ByteArray<N>

where Rhs: Borrow<[u8; N]> + ?Sized,

fn eq(&self, other: &Rhs) -> 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<Rhs, const N: usize> PartialOrd<Rhs> for ByteArray<N>

where Rhs: Borrow<[u8; N]> + ?Sized,

fn partial_cmp(&self, other: &Rhs) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const N: usize> Serialize for ByteArray<N>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<const N: usize> Serialize for ByteArray<N>

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

where S: Serializer,

impl<const N: usize> Copy for ByteArray<N>

impl<const N: usize> Eq for ByteArray<N>