Struct BytesN 

pub struct BytesN<const N: usize>(/* private fields */);

BytesN is a contiguous fixed-size array type containing u8s.

The array is stored in the Host and available to the Guest through the functions defined on Bytes.

Bytes values can be stored as Storage, or in other types like Vec, Map, etc.

Examples

BytesN values can be created from arrays:

use soroban_sdk::{Bytes, BytesN, Env};

let env = Env::default();
let bytes = BytesN::from_array(&env, &[0; 32]);
assert_eq!(bytes.len(), 32);

BytesN and Bytes values are convertible:

use soroban_sdk::{Bytes, BytesN, Env};

let env = Env::default();
let bytes = Bytes::from_slice(&env, &[0; 32]);
let bytes: BytesN<32> = bytes.try_into().expect("bytes to have length 32");
assert_eq!(bytes.len(), 32);

Implementations

impl<const N: usize> BytesN<N>

pub fn env(&self) -> &Env

pub fn as_val(&self) -> &Val

pub fn to_val(&self) -> Val

pub fn as_object(&self) -> &BytesObject

pub fn to_object(&self) -> BytesObject

pub fn from_array(env: &Env, items: &[u8; N]) -> BytesN<N>

Create a BytesN from the slice.

pub fn set(&mut self, i: u32, v: u8)

Sets the byte at the position with new value.

Panics

If the position is out-of-bounds.

pub fn get(&self, i: u32) -> Option<u8>

Returns the byte at the position or None if out-of-bounds.

pub fn get_unchecked(&self, i: u32) -> u8

Returns the byte at the position.

Panics

If the position is out-of-bounds.

pub fn is_empty(&self) -> bool

Returns true if the Bytes is empty and has a length of zero.

pub fn len(&self) -> u32

Returns the number of bytes are in the Bytes.

pub fn first(&self) -> Option<u8>

Returns the first byte or None if empty.

pub fn first_unchecked(&self) -> u8

Returns the first byte.

Panics

If the Bytes is empty.

pub fn last(&self) -> Option<u8>

Returns the last byte or None if empty.

pub fn last_unchecked(&self) -> u8

Returns the last byte.

Panics

If the Bytes is empty.

pub fn copy_into_slice(&self, slice: &mut [u8; N])

Copy the bytes into the given slice.

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

Copy the bytes in BytesN into an array.

pub fn iter(&self) -> BytesIter

Trait Implementations

impl<const N: usize> AsRef<Bytes> for BytesN<N>

fn as_ref(&self) -> &Bytes

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

impl<const N: usize> Borrow<Bytes> for &BytesN<N>

fn borrow(&self) -> &Bytes

Immutably borrows from an owned value.

impl<const N: usize> Borrow<Bytes> for &mut BytesN<N>

fn borrow(&self) -> &Bytes

Immutably borrows from an owned value.

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

fn borrow(&self) -> &Bytes

Immutably borrows from an owned value.

impl<const N: usize> BytesN<N> for BytesN<N>

Available on crate feature testutils only.

fn random(env: &Env) -> BytesN<N>

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

fn clone(&self) -> BytesN<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 BytesN<N>

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

Formats the value using the given formatter.

impl<const N: usize> Fill for BytesN<N>

fn fill(&mut self, prng: &Prng)

Fills the BytesN with the Prng.

Panics

If the length of BytesN is greater than u32::MAX in length.

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

fn from(bin: &BytesN<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<&BytesN<N>> for Bytes

fn from(v: &BytesN<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<&BytesN<N>> for ScVal

fn from(v: &BytesN<N>) -> Self

Converts to this type from the input type.

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

fn from(bin: BytesN<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<BytesN<N>> for Bytes

fn from(v: BytesN<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<BytesN<N>> for ScVal

fn from(v: BytesN<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<BytesN<N>> for Val

fn from(v: BytesN<N>) -> Self

Converts to this type from the input type.

impl From<Fp> for BytesN<FP_SERIALIZED_SIZE>

fn from(v: Fp) -> Self

Converts to this type from the input type.

impl From<Fp2> for BytesN<FP2_SERIALIZED_SIZE>

fn from(v: Fp2) -> Self

Converts to this type from the input type.

impl From<G1Affine> for BytesN<G1_SERIALIZED_SIZE>

fn from(v: G1Affine) -> Self

Converts to this type from the input type.

impl From<G2Affine> for BytesN<G2_SERIALIZED_SIZE>

fn from(v: G2Affine) -> Self

Converts to this type from the input type.

impl<const N: usize> From<Hash<N>> for BytesN<N>

fn from(v: Hash<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> Gen for BytesN<N>

fn gen(prng: &Prng) -> Self

Generates the BytesN with the Prng.

Panics

If the length of BytesN is greater than u32::MAX in length.

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

type Item = u8

The type of the elements being iterated over.

type IntoIter = BytesIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoVal<Env, BytesN<FP2_SERIALIZED_SIZE>> for Fp2

fn into_val(&self, _e: &Env) -> BytesN<FP2_SERIALIZED_SIZE>

impl IntoVal<Env, BytesN<FP_SERIALIZED_SIZE>> for Fp

fn into_val(&self, _e: &Env) -> BytesN<FP_SERIALIZED_SIZE>

impl IntoVal<Env, BytesN<G1_SERIALIZED_SIZE>> for G1Affine

fn into_val(&self, _e: &Env) -> BytesN<G1_SERIALIZED_SIZE>

impl IntoVal<Env, BytesN<G2_SERIALIZED_SIZE>> for G2Affine

fn into_val(&self, _e: &Env) -> BytesN<G2_SERIALIZED_SIZE>

impl<const N: usize> IntoVal<Env, BytesN<N>> for Hash<N>

fn into_val(&self, _e: &Env) -> BytesN<N>

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

fn cmp(&self, other: &Self) -> 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<const N: usize> PartialEq<[u8; N]> for BytesN<N>

fn eq(&self, other: &[u8; 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<const N: usize> PartialEq<BytesN<N>> for [u8; N]

fn eq(&self, other: &BytesN<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<const N: usize> PartialEq for BytesN<N>

fn eq(&self, other: &Self) -> 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<const N: usize> PartialOrd<[u8; N]> for BytesN<N>

fn partial_cmp(&self, other: &[u8; N]) -> 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> PartialOrd<BytesN<N>> for [u8; N]

fn partial_cmp(&self, other: &BytesN<N>) -> 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> PartialOrd for BytesN<N>

fn partial_cmp(&self, other: &Self) -> 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> SorobanArbitrary for BytesN<N>

Available on crate feature testutils only.

type Prototype = ArbitraryBytesN<N>

A type that implements Arbitrary and can be converted to this SorobanArbitrary type.

impl<const N: usize> TryFrom<&Bytes> for BytesN<N>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(bin: &Bytes) -> Result<Self, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<Bytes> for BytesN<N>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(bin: Bytes) -> Result<Self, Self::Error>

Performs the conversion.

impl<const N: usize> TryFromVal<Env, &BytesN<N>> for Val

type Error = ConversionError

fn try_from_val(_env: &Env, v: &&BytesN<N>) -> Result<Self, Self::Error>

impl<const N: usize> TryFromVal<Env, [u8; N]> for BytesN<N>

type Error = ConversionError

fn try_from_val(env: &Env, v: &[u8; N]) -> Result<Self, Self::Error>

impl<const N: usize> TryFromVal<Env, BytesN<N>> for [u8; N]

type Error = ConversionError

fn try_from_val(_env: &Env, v: &BytesN<N>) -> Result<Self, Self::Error>

impl<const N: usize> TryFromVal<Env, BytesN<N>> for Bytes

type Error = ConversionError

fn try_from_val(_env: &Env, v: &BytesN<N>) -> Result<Self, Self::Error>

impl<const N: usize> TryFromVal<Env, BytesN<N>> for BytesN<N>

type Error = ConversionError

fn try_from_val(_env: &Env, v: &BytesN<N>) -> Result<Self, Self::Error>

impl<const N: usize> TryFromVal<Env, BytesN<N>> for Val

type Error = ConversionError

fn try_from_val(_env: &Env, v: &BytesN<N>) -> Result<Self, Self::Error>

impl<const N: usize> TryFromVal<Env, BytesObject> for BytesN<N>

type Error = ConversionError

fn try_from_val(env: &Env, obj: &BytesObject) -> Result<Self, Self::Error>

impl<const N: usize> TryFromVal<Env, ScVal> for BytesN<N>

type Error = ConversionError

fn try_from_val(env: &Env, val: &ScVal) -> Result<Self, Self::Error>

impl<const N: usize> TryFromVal<Env, Val> for BytesN<N>

type Error = ConversionError

fn try_from_val(env: &Env, val: &Val) -> Result<Self, Self::Error>

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