Struct dryoc::types::StackByteArray

pub struct StackByteArray<const LENGTH: usize>(_);

A stack-allocated fixed-length byte array for working with data, with optional Serde features.

Implementations

impl<const LENGTH: usize> StackByteArray<LENGTH>

pub fn mlock(
    self
) -> Result<Protected<HeapByteArray<LENGTH>, ReadWrite, Locked>, Error>

This is supported on crate feature nightly only.

Locks a StackByteArray, consuming it, and returning a Protected wrapper.

impl<const LENGTH: usize> StackByteArray<LENGTH>

pub fn mprotect_readonly(
    self
) -> Result<Protected<HeapByteArray<LENGTH>, ReadOnly, Unlocked>, Error>

This is supported on crate feature nightly only.

Returns a readonly protected StackByteArray.

impl<const LENGTH: usize> StackByteArray<LENGTH>

pub fn new() -> Self

Returns a new fixed-length stack-allocated array

Trait Implementations

impl<const LENGTH: usize> AsMut<[u8; LENGTH]> for StackByteArray<LENGTH>

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

Performs the conversion.

impl<const LENGTH: usize> AsMut<[u8]> for StackByteArray<LENGTH>

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

Performs the conversion.

impl<const LENGTH: usize> AsRef<[u8; LENGTH]> for StackByteArray<LENGTH>

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

Performs the conversion.

impl<const LENGTH: usize> AsRef<[u8]> for StackByteArray<LENGTH>

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

Performs the conversion.

impl<const LENGTH: usize> ByteArray<LENGTH> for StackByteArray<LENGTH>

fn as_array(&self) -> &[u8; LENGTH]

Returns a reference to the underlying fixed-length byte array.

impl<const LENGTH: usize> Bytes for StackByteArray<LENGTH>

fn as_slice(&self) -> &[u8]

Returns a slice of the underlying bytes.

fn len(&self) -> usize

Shorthand to retrieve the underlying length of the byte array.

fn is_empty(&self) -> bool

Returns true if the array is empty.

impl<const LENGTH: usize> Clone for StackByteArray<LENGTH>

fn clone(&self) -> StackByteArray<LENGTH>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const LENGTH: usize> Debug for StackByteArray<LENGTH>

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

Formats the value using the given formatter.

impl<const LENGTH: usize> Default for StackByteArray<LENGTH>

fn default() -> Self

Returns the “default value” for a type.

impl<const LENGTH: usize> Deref for StackByteArray<LENGTH>

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<const LENGTH: usize> DerefMut for StackByteArray<LENGTH>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, const LENGTH: usize> Deserialize<'de> for StackByteArray<LENGTH>

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

Deserialize this value from the given Serde deserializer.

impl<const LENGTH: usize> Drop for StackByteArray<LENGTH>

fn drop(&mut self)

Executes the destructor for this type.

impl<const LENGTH: usize> From<&'_ [u8; LENGTH]> for StackByteArray<LENGTH>

fn from(src: &[u8; LENGTH]) -> Self

Performs the conversion.

impl<const LENGTH: usize> From<[u8; LENGTH]> for StackByteArray<LENGTH>

fn from(src: [u8; LENGTH]) -> Self

Performs the conversion.

impl<const LENGTH: usize> From<StackByteArray<LENGTH>> for HeapByteArray<LENGTH>

This is supported on crate feature nightly only.

fn from(other: StackByteArray<LENGTH>) -> Self

Performs the conversion.

impl<const LENGTH: usize> Index<Range<usize>> for StackByteArray<LENGTH>

type Output = [u8]

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<const LENGTH: usize> Index<RangeFrom<usize>> for StackByteArray<LENGTH>

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<const LENGTH: usize> Index<RangeFull> for StackByteArray<LENGTH>

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeFull) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<const LENGTH: usize> Index<RangeInclusive<usize>> for StackByteArray<LENGTH>

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeInclusive<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<const LENGTH: usize> Index<RangeTo<usize>> for StackByteArray<LENGTH>

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<const LENGTH: usize> Index<RangeToInclusive<usize>> for StackByteArray<LENGTH>

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeToInclusive<usize>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<const LENGTH: usize> Index<usize> for StackByteArray<LENGTH>

type Output = u8

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<const LENGTH: usize> IndexMut<Range<usize>> for StackByteArray<LENGTH>

fn index_mut(&mut self, index: Range<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<const LENGTH: usize> IndexMut<RangeFrom<usize>> for StackByteArray<LENGTH>

fn index_mut(&mut self, index: RangeFrom<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<const LENGTH: usize> IndexMut<RangeFull> for StackByteArray<LENGTH>

fn index_mut(&mut self, index: RangeFull) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<const LENGTH: usize> IndexMut<RangeInclusive<usize>> for StackByteArray<LENGTH>

fn index_mut(&mut self, index: RangeInclusive<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<const LENGTH: usize> IndexMut<RangeTo<usize>> for StackByteArray<LENGTH>

fn index_mut(&mut self, index: RangeTo<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<const LENGTH: usize> IndexMut<RangeToInclusive<usize>> for StackByteArray<LENGTH>

fn index_mut(&mut self, index: RangeToInclusive<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<const LENGTH: usize> IndexMut<usize> for StackByteArray<LENGTH>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<const LENGTH: usize> MutByteArray<LENGTH> for StackByteArray<LENGTH>

fn as_mut_array(&mut self) -> &mut [u8; LENGTH]

Returns a mutable reference to the underlying fixed-length byte array.

impl<const LENGTH: usize> MutBytes for StackByteArray<LENGTH>

fn as_mut_slice(&mut self) -> &mut [u8]

Returns a mutable slice to the underlying bytes.

fn copy_from_slice(&mut self, other: &[u8])

Copies into the underlying slice from other. Panics if lengths do not match.

impl<const LENGTH: usize> NewByteArray<LENGTH> for StackByteArray<LENGTH>

fn gen() -> Self

Returns a new byte array filled with random data.

fn new_byte_array() -> Self

Returns a new fixed-length byte array, initialized with zeroes.

impl<const LENGTH: usize> NewBytes for StackByteArray<LENGTH>

fn new_bytes() -> Self

Returns an empty, unallocated, arbitrary-length byte array.

impl<const LENGTH: usize> PartialEq<StackByteArray<LENGTH>> for StackByteArray<LENGTH>

fn eq(&self, other: &StackByteArray<LENGTH>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StackByteArray<LENGTH>) -> bool

This method tests for !=.

impl<const LENGTH: usize> Serialize for StackByteArray<LENGTH>

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

Serialize this value into the given Serde serializer.

impl<'a, const LENGTH: usize> TryFrom<&'a [u8]> for StackByteArray<LENGTH>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(src: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<const LENGTH: usize> Zeroize for StackByteArray<LENGTH>

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<const LENGTH: usize> StructuralPartialEq for StackByteArray<LENGTH>