Struct BytesN

Source

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

Expand description

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§

Source §

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

Create a BytesN from the slice.

Source

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.

Source

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

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

Source

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

Returns the byte at the position.

§Panics

If the position is out-of-bounds.

Source

pub fn is_empty(&self) -> bool

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

Source

pub fn len(&self) -> u32

Returns the number of bytes are in the Bytes.

Source

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

Returns the first byte or None if empty.

Source

pub fn first_unchecked(&self) -> u8

Returns the first byte.

§Panics

If the Bytes is empty.

Source

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

Returns the last byte or None if empty.

Source

pub fn last_unchecked(&self) -> u8

Returns the last byte.

§Panics

If the Bytes is empty.

Source

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

Copy the bytes into the given slice.

Source

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

Copy the bytes in BytesN into an array.

Source

pub fn iter(&self) -> BytesIter

Trait Implementations§

Source §

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

Source §

fn as_ref(&self) -> &Bytes

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

Source §

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

Source §

fn borrow(&self) -> &Bytes

Immutably borrows from an owned value. Read more

Source §

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

Source §

fn borrow(&self) -> &Bytes

Immutably borrows from an owned value. Read more

Source §

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

Source §

fn borrow(&self) -> &Bytes

Immutably borrows from an owned value. Read more

Source §

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

Source §

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

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

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

Source §

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

Formats the value using the given formatter. Read more

Source §

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

Source §

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.

Source §