Struct soroban_sdk::Bytes

#[repr(transparent)]
pub struct Bytes(_);

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

pub fn to_raw(&self) -> RawVal

pub fn as_object(&self) -> &Object

pub fn to_object(&self) -> Object

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 given [u8].

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

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

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

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

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

pub fn pop_unchecked(&mut self) -> u8

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

Insert the byte into this Bytes at position indicated by i, and growing the size of Bytes by 1.

Panics

When i is greater than the length of Bytes.

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

Insert the bytes in bytes into this Bytes starting at position indicated by i, and growing the size of Bytes by the length of `bytes.

Panics

When i is greater than the length of Bytes.

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

Insert the bytes in array into this Bytes starting at position indicated by i, and growing the size of Bytes by the length of `bytes.

Panics

When i is greater than the length of Bytes.

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

Insert the bytes in slice into this Bytes starting at position indicated by i, and growing the size of Bytes by the length of `bytes.

Panics

When i is greater than the length of Bytes.

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

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

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

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

Copy the bytes from slice into Bytes.

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 in Bytes into the given slice.

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

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

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

fn clone(&self) -> Bytes

Returns a copy of the value.

const 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 From<&Bytes> for Bytes

fn from(v: &Bytes) -> Self

Converts to this type from the input type.

impl From<&Bytes> for Object

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 EnvVal<Env, Object>

fn from(v: Bytes) -> Self

Converts to this type from the input type.

impl From<Bytes> for Object

fn from(v: Bytes) -> Self

Converts to this type from the input type.

impl From<Bytes> for RawVal

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

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> IntoVal<Env, Bytes> for &[u8; N]

fn into_val(self, env: &Env) -> Bytes

fn into_env_val(self, env: &E) -> EnvVal<E, V>

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

fn into_val(self, env: &Env) -> Bytes

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl IntoVal<Env, Bytes> for &Bytes

fn into_val(self, _env: &Env) -> Bytes

fn into_env_val(self, env: &E) -> EnvVal<E, V>

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

fn into_val(self, _env: &Env) -> Bytes

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl IntoVal<Env, Bytes> for &str

fn into_val(self, env: &Env) -> Bytes

fn into_env_val(self, env: &E) -> EnvVal<E, V>

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

fn into_val(self, env: &Env) -> Bytes

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl IntoVal<Env, Bytes> for Bytes

fn into_val(self, _env: &Env) -> Bytes

fn into_env_val(self, env: &E) -> EnvVal<E, V>

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

fn into_val(self, _env: &Env) -> Bytes

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl IntoVal<Env, RawVal> for &Bytes

fn into_val(self, _env: &Env) -> RawVal

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl IntoVal<Env, RawVal> for Bytes

fn into_val(self, _env: &Env) -> RawVal

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl Ord for Bytes

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Bytes> for Bytes

fn eq(&self, other: &Self) -> bool

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

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

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

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

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

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

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

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

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

const 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 TryFrom<&Bytes> for ScVal

type Error = ConversionError

The type returned in the event of a conversion error.

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

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, Self::Error>

Performs the conversion.

impl TryFromVal<Env, Object> for Bytes

type Error = ConversionError

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

impl TryFromVal<Env, RawVal> for Bytes

type Error = <Bytes as TryFromVal<Env, Object>>::Error

fn try_from_val(env: &Env, val: RawVal) -> 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 TryIntoVal<Env, Bytes> for Object

type Error = ConversionError

fn try_into_val(self, env: &Env) -> Result<Bytes, Self::Error>

fn try_into_env_val(self, env: &E) -> Result<EnvVal<E, V>, Self::Error>

impl TryIntoVal<Env, Bytes> for RawVal

type Error = ConversionError

fn try_into_val(self, env: &Env) -> Result<Bytes, Self::Error>

fn try_into_env_val(self, env: &E) -> Result<EnvVal<E, V>, Self::Error>

impl TryIntoVal<Env, Bytes> for ScVal

type Error = ConversionError

fn try_into_val(self, env: &Env) -> Result<Bytes, Self::Error>

fn try_into_env_val(self, env: &E) -> Result<EnvVal<E, V>, Self::Error>

impl Eq for Bytes