Struct amplify::Array

pub struct Array<T, const LEN: usize, const REVERSE_STR: bool = false>(/* private fields */);

Wrapper type for all fixed arrays implementing many important traits, so types based on it can simply derive their implementations.

Type keeps data in little-endian byte order and displays them in the same order (like bitcoin SHA256 single hash type).

Implementations

impl<T, const LEN: usize, const REVERSE_STR: bool> Array<T, LEN, REVERSE_STR>

pub fn with_fill(val: T) -> Self

where T: Copy,

Constructs array filled with given value. TODO: Revert commit 7110cee0cf539d8ff4270450183f7060a585bc87 and make method const once const_fn_trait_bound stabilize

pub const fn from_array(inner: [T; LEN]) -> Self

Wraps inner representation into array type.

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

Returns byte slice representation.

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

Returns mutable byte slice representation.

pub fn to_vec(&self) -> Vec<T>

where T: Clone,

Returns vector representing internal slice data

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the array items.

The iterator yields all items from start to end.

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns an iterator that allows modifying each value.

The iterator yields all items from start to end.

impl<const LEN: usize, const REVERSE_STR: bool> Array<u8, LEN, REVERSE_STR>

pub const fn zero() -> Self

Constructs array filled with zero bytes

pub fn from_slice_unsafe(slice: impl AsRef<[u8]>) -> Self

Constructs a byte array from the slice. Expects the slice length doesn’t match LEN constant generic.

Safety

Panics if the slice length doesn’t match LEN constant generic.

pub fn to_byte_array(&self) -> [u8; LEN]

Returns a byte array representation stored in the wrapped type.

pub fn from_byte_array(val: impl Into<[u8; LEN]>) -> Self

Constructs Array type from another type containing raw array.

impl<T, const LEN: usize, const REVERSE_STR: bool> Array<T, LEN, REVERSE_STR>

where T: Default + Copy,

pub fn from_slice(slice: impl AsRef<[T]>) -> Option<Self>

👎Deprecated since 4.2.0: use copy_from_slice

Constructs 256-bit array from a provided slice. If the slice length is not equal to LEN bytes, returns None

pub fn copy_from_slice(slice: impl AsRef<[T]>) -> Result<Self, FromSliceError>

Constructs 256-bit array by copying from a provided slice. Errors if the slice length is not equal to LEN bytes.

Trait Implementations

impl<T, const LEN: usize, const REVERSE_STR: bool> AsMut<[T]> for Array<T, LEN, REVERSE_STR>

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

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

impl<T, const LEN: usize, const REVERSE_STR: bool> AsRef<[T]> for Array<T, LEN, REVERSE_STR>

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

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

impl<const LEN: usize, const REVERSE_STR: bool> BitAnd for Array<u8, LEN, REVERSE_STR>

type Output = Array<u8, LEN, REVERSE_STR>

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl<const LEN: usize, const REVERSE_STR: bool> BitAndAssign for Array<u8, LEN, REVERSE_STR>

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl<const LEN: usize, const REVERSE_STR: bool> BitOr for Array<u8, LEN, REVERSE_STR>

type Output = Array<u8, LEN, REVERSE_STR>

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl<const LEN: usize, const REVERSE_STR: bool> BitOrAssign for Array<u8, LEN, REVERSE_STR>

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl<const LEN: usize, const REVERSE_STR: bool> BitXor for Array<u8, LEN, REVERSE_STR>

type Output = Array<u8, LEN, REVERSE_STR>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl<const LEN: usize, const REVERSE_STR: bool> BitXorAssign for Array<u8, LEN, REVERSE_STR>

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl<T, const LEN: usize, const REVERSE_STR: bool> Borrow<[T]> for Array<T, LEN, REVERSE_STR>

fn borrow(&self) -> &[T]

Immutably borrows from an owned value.

impl<T, const LEN: usize, const REVERSE_STR: bool> BorrowMut<[T]> for Array<T, LEN, REVERSE_STR>

fn borrow_mut(&mut self) -> &mut [T]

Mutably borrows from an owned value.

impl<T: Clone, const LEN: usize, const REVERSE_STR: bool> Clone for Array<T, LEN, REVERSE_STR>

fn clone(&self) -> Array<T, LEN, REVERSE_STR>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const LEN: usize, const REVERSE_STR: bool> Debug for Array<u8, LEN, REVERSE_STR>

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

Formats the value using the given formatter.

impl<T, const LEN: usize, const REVERSE_STR: bool> Default for Array<T, LEN, REVERSE_STR>

where T: Default + Copy,

fn default() -> Self

Returns the “default value” for a type.

impl<const LEN: usize, const REVERSE_STR: bool> Display for Array<u8, LEN, REVERSE_STR>

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

Formats the value using the given formatter.

impl<T, const LEN: usize> Dumb for Array<T, LEN>

where T: Dumb + Copy,

fn dumb() -> Self

Returns an object initialized with dumb data

impl<T, const LEN: usize, const REVERSE_STR: bool> From<[T; LEN]> for Array<T, LEN, REVERSE_STR>

fn from(array: [T; LEN]) -> Self

Converts to this type from the input type.

impl<T, const LEN: usize, const REVERSE_STR: bool> From<T> for Array<T, LEN, REVERSE_STR>

where T: Into<[T; LEN]>,

fn from(array: T) -> Self

Converts to this type from the input type.

impl<const LEN: usize, const REVERSE_STR: bool> FromHex for Array<u8, LEN, REVERSE_STR>

fn from_byte_iter<I>(iter: I) -> Result<Self, Error>

where I: Iterator<Item = Result<u8, Error>> + ExactSizeIterator + DoubleEndedIterator,

Produce an object from a byte iterator

fn from_hex(s: &str) -> Result<Self, Error>

Produce an object from a hex string

impl<const LEN: usize, const REVERSE_STR: bool> FromStr for Array<u8, LEN, REVERSE_STR>

type Err = Error

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<T: Hash, const LEN: usize, const REVERSE_STR: bool> Hash for Array<T, LEN, REVERSE_STR>

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

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<T, const LEN: usize, const REVERSE_STR: bool> Index<Range<usize>> for Array<T, LEN, REVERSE_STR>

type Output = [T]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T, const LEN: usize, const REVERSE_STR: bool> Index<RangeFrom<usize>> for Array<T, LEN, REVERSE_STR>

type Output = [T]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T, const LEN: usize, const REVERSE_STR: bool> Index<RangeFull> for Array<T, LEN, REVERSE_STR>

type Output = [T]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T, const LEN: usize, const REVERSE_STR: bool> Index<RangeInclusive<usize>> for Array<T, LEN, REVERSE_STR>

type Output = [T]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T, const LEN: usize, const REVERSE_STR: bool> Index<RangeTo<usize>> for Array<T, LEN, REVERSE_STR>

type Output = [T]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T, const LEN: usize, const REVERSE_STR: bool> Index<RangeToInclusive<usize>> for Array<T, LEN, REVERSE_STR>

type Output = [T]

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T, const LEN: usize, const REVERSE_STR: bool> Index<usize> for Array<T, LEN, REVERSE_STR>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T, const LEN: usize, const REVERSE_STR: bool> IndexMut<Range<usize>> for Array<T, LEN, REVERSE_STR>

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

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

impl<T, const LEN: usize, const REVERSE_STR: bool> IndexMut<RangeFrom<usize>> for Array<T, LEN, REVERSE_STR>

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

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

impl<T, const LEN: usize, const REVERSE_STR: bool> IndexMut<RangeFull> for Array<T, LEN, REVERSE_STR>

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

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

impl<T, const LEN: usize, const REVERSE_STR: bool> IndexMut<RangeInclusive<usize>> for Array<T, LEN, REVERSE_STR>

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

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

impl<T, const LEN: usize, const REVERSE_STR: bool> IndexMut<RangeTo<usize>> for Array<T, LEN, REVERSE_STR>

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

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

impl<T, const LEN: usize, const REVERSE_STR: bool> IndexMut<RangeToInclusive<usize>> for Array<T, LEN, REVERSE_STR>

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

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

impl<T, const LEN: usize, const REVERSE_STR: bool> IndexMut<usize> for Array<T, LEN, REVERSE_STR>

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

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

impl<T, const LEN: usize, const REVERSE_STR: bool> IntoIterator for Array<T, LEN, REVERSE_STR>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T, LEN>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<const LEN: usize, const REVERSE_STR: bool> LowerHex for Array<u8, LEN, REVERSE_STR>

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

Formats the value using the given formatter.

impl<const LEN: usize, const REVERSE_STR: bool> Not for Array<u8, LEN, REVERSE_STR>

type Output = Array<u8, LEN, REVERSE_STR>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T: Ord, const LEN: usize, const REVERSE_STR: bool> Ord for Array<T, LEN, REVERSE_STR>

fn cmp(&self, other: &Array<T, LEN, REVERSE_STR>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<T: PartialEq, const LEN: usize, const REVERSE_STR: bool> PartialEq for Array<T, LEN, REVERSE_STR>

fn eq(&self, other: &Array<T, LEN, REVERSE_STR>) -> bool

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

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

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

impl<T: PartialOrd, const LEN: usize, const REVERSE_STR: bool> PartialOrd for Array<T, LEN, REVERSE_STR>

fn partial_cmp(&self, other: &Array<T, LEN, REVERSE_STR>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T, const LEN: usize, const REVERSE_STR: bool> TryFrom<&[T]> for Array<T, LEN, REVERSE_STR>

where T: Copy + Default,

type Error = FromSliceError

The type returned in the event of a conversion error.

fn try_from(value: &[T]) -> Result<Self, Self::Error>

Performs the conversion.

impl<const LEN: usize, const REVERSE_STR: bool> UpperHex for Array<u8, LEN, REVERSE_STR>

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

Formats the value using the given formatter.

impl<T, const LEN: usize, const REVERSE_STR: bool> Wrapper for Array<T, LEN, REVERSE_STR>

type Inner = [T; LEN]

Inner type wrapped by the current newtype

fn from_inner(inner: Self::Inner) -> Self

Instantiates wrapper type with the inner data

fn as_inner(&self) -> &Self::Inner

Returns reference to the inner representation for the wrapper type

fn into_inner(self) -> Self::Inner

Unwraps the wrapper returning the inner type

impl<T, const LEN: usize, const REVERSE_STR: bool> WrapperMut for Array<T, LEN, REVERSE_STR>

fn as_inner_mut(&mut self) -> &mut Self::Inner

Returns a mutable reference to the inner representation for the wrapper type

impl<T: Copy, const LEN: usize, const REVERSE_STR: bool> Copy for Array<T, LEN, REVERSE_STR>

impl<T: Eq, const LEN: usize, const REVERSE_STR: bool> Eq for Array<T, LEN, REVERSE_STR>

impl<T, const LEN: usize, const REVERSE_STR: bool> StructuralPartialEq for Array<T, LEN, REVERSE_STR>