Struct soroban_sdk::BytesN

#[repr(transparent)]
pub struct BytesN<const N: usize>(_);

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_raw(&self) -> &RawVal

pub fn to_raw(&self) -> RawVal

pub fn as_object(&self) -> &BytesObject

pub fn to_object(&self) -> BytesObject

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

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

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

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

pub fn is_empty(&self) -> bool

pub fn len(&self) -> u32

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

pub fn first_unchecked(&self) -> u8

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

pub fn last_unchecked(&self) -> u8

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

Copy the bytes in BytesN into the given slice.

The minimum number of bytes are copied to either exhaust BytesN or fill slice.

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

Copy the bytes in BytesN into an array.

pub fn iter(&self) -> BinIter

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 copy 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> 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 [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 RawVal

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

Converts to this type from the input type.

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

type Item = u8

The type of the elements being iterated over.

type IntoIter = BinIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

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

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

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

fn eq(&self, other: &Self) -> 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<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

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<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

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<const N: usize> PartialOrd<BytesN<N>> 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

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<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<&BytesN<N>> for ScVal

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(v: &BytesN<N>) -> 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> TryFrom<BytesN<N>> for ScVal

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(v: BytesN<N>) -> Result<Self, Self::Error>

Performs the conversion.

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 RawVal

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, RawVal> for BytesN<N>

type Error = ConversionError

fn try_from_val(env: &Env, val: &RawVal) -> 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> Eq for BytesN<N>