Struct soroban_sdk::Bytes

source ·

pub struct Bytes { /* private fields */ }

Expand description

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§

source §

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

Create an empty Bytes.

source

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

Create a Bytes from the given [u8].

source

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

source

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

source

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

source

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

source

pub fn is_empty(&self) -> bool

source

pub fn len(&self) -> u32

source

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

source

pub fn first_unchecked(&self) -> u8

source

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

source

pub fn last_unchecked(&self) -> u8

source

pub fn remove(&mut self, i: u32) -> Option<()>

source

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

source

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

source

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

source

pub fn pop_unchecked(&mut self) -> u8

source

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.

source

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.

source

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.

source

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.

source

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

source

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

source

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

source

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.

source

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.

source

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

source

pub fn iter(&self) -> BinIter

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

source §

fn clone(&self) -> Bytes

Returns a copy 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 Debug for Bytes

source §

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

Formats the value using the given formatter. Read more

source §