Struct soroban_sdk::Bytes

pub struct Bytes { /* private fields */ }

Bytes is a contiguous growable 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

Bytes values can be created from slices:

use soroban_sdk::{Bytes, Env};

let env = Env::default();
let bytes = Bytes::from_slice(&env, &[1; 32]);
assert_eq!(bytes.len(), 32);
let mut slice = [0u8; 32];
bytes.copy_into_slice(&mut slice);
assert_eq!(slice, [1u8; 32]);

Implementations

impl Bytes

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

impl Bytes

pub fn new(env: &Env) -> Bytes

Create an empty Bytes.

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

Create a Bytes from the array.

pub fn from_slice(env: &Env, items: &[u8]) -> Bytes

Create a Bytes 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 remove(&mut self, i: u32) -> Option<()>

Removes the byte at the position.

Returns None if out-of-bounds.

pub fn remove_unchecked(&mut self, i: u32)

Removes the byte at the position.

Panics

If the position is out-of-bounds.

pub fn push_back(&mut self, x: u8)

Adds the byte to the back.

Increases the length by one and puts the byte in the last position.

pub fn pop_back(&mut self) -> Option<u8>

Removes and returns the last byte or None if empty.

pub fn pop_back_unchecked(&mut self) -> u8

Removes and returns the last byte or None if empty.

Panics

If the Bytes is empty.

pub fn insert(&mut self, i: u32, b: u8)

Insert the byte at the position.

Panics

If the position is out-of-bounds.

pub fn insert_from_bytes(&mut self, i: u32, bytes: Bytes)

Insert the bytes at the position.

Panics

If the position is out-of-bounds.

pub fn insert_from_array<const N: usize>(&mut self, i: u32, array: &[u8; N])

Insert the bytes at the position.

Panics

If the position is out-of-bounds.

pub fn insert_from_slice(&mut self, i: u32, slice: &[u8])

Insert the bytes at the position.

Panics

If the position is out-of-bounds.

pub fn append(&mut self, other: &Bytes)

Append the bytes.

pub fn extend_from_array<const N: usize>(&mut self, array: &[u8; N])

Extend with the bytes in the array.

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

Extend with the bytes in the slice.

pub fn copy_from_slice(&mut self, i: u32, slice: &[u8])

Copy the bytes from slice.

The full number of bytes in slice are always copied and Bytes is grown if necessary.

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

Copy the bytes into the given slice.

Panics

If the output slice and bytes are of different lengths.

pub fn slice(&self, r: impl RangeBounds<u32>) -> Self

Returns a subset of the bytes as defined by the start and end bounds of the range.

Panics

If the range is out-of-bounds.

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 Clone for Bytes

fn clone(&self) -> Bytes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bytes

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

Formats the value using the given formatter.

impl Fill for Bytes

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

Fills the Bytes with the Prng.

Panics

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

impl From<&Bytes> for Bytes

fn from(v: &Bytes) -> Self

Converts to this type from the input type.

impl From<&Bytes> for BytesObject

fn from(v: &Bytes) -> 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 From<Bytes> for BytesObject

fn from(v: Bytes) -> Self

Converts to this type from the input type.

impl From<Bytes> for Val

fn from(v: Bytes) -> 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 GenLen for Bytes

fn gen_len(prng: &Prng, len: u32) -> Self

Generates the Bytes with the Prng of the given length.

type Len = u32

impl IntoIterator for Bytes

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 Ord for Bytes

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Bytes

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 PartialOrd for Bytes

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 SorobanArbitrary for Bytes

Available on crate feature testutils only.

type Prototype = ArbitraryBytes

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

impl<const N: usize> TryFrom<&Bytes> for [u8; 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 TryFrom<&Bytes> for ScVal

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(v: &Bytes) -> Result<Self, ConversionError>

Performs the conversion.

impl<const N: usize> TryFrom<Bytes> for [u8; 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 TryFrom<Bytes> for ScVal

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(v: Bytes) -> Result<Self, ConversionError>

Performs the conversion.

impl TryFromVal<Env, &[u8]> for Bytes

type Error = ConversionError

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

impl TryFromVal<Env, &str> for Bytes

type Error = ConversionError

fn try_from_val(env: &Env, v: &&str) -> Result<Self, Self::Error>

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

type Error = ConversionError

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

impl TryFromVal<Env, Bytes> for Bytes

type Error = ConversionError

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

impl TryFromVal<Env, Bytes> for Val

type Error = ConversionError

fn try_from_val(_env: &Env, v: &Bytes) -> 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 TryFromVal<Env, BytesObject> for Bytes

type Error = Infallible

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

impl TryFromVal<Env, ScVal> for Bytes

type Error = ConversionError

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

impl TryFromVal<Env, Val> for Bytes

type Error = ConversionError

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

impl Eq for Bytes