Struct String

pub struct String { /* private fields */ }

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

String values can be stored as Storage, or in other types like Vec, Map, etc.

Examples

String values can be created from slices:

use soroban_sdk::{String, Env};

let env = Env::default();
let msg = "a message";
let s = String::from_str(&env, msg);
let mut out = [0u8; 9];
s.copy_into_slice(&mut out);
assert_eq!(msg.as_bytes(), out)

Implementations

impl String

pub fn env(&self) -> &Env

pub fn as_val(&self) -> &Val

pub fn to_val(&self) -> Val

pub fn as_object(&self) -> &StringObject

pub fn to_object(&self) -> StringObject

pub fn from_bytes(env: &Env, b: &[u8]) -> String

pub fn from_str(env: &Env, s: &str) -> String

pub fn len(&self) -> u32

pub fn is_empty(&self) -> bool

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

Copy the bytes in String into the given slice.

Panics

If the output slice and string are of different lengths.

Trait Implementations

impl Clone for String

fn clone(&self) -> String

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for String

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

Formats the value using the given formatter.

impl From<&String> for ScVal

fn from(v: &String) -> Self

Converts to this type from the input type.

impl From<&String> for String

fn from(v: &String) -> Self

Converts to this type from the input type.

impl From<&String> for StringObject

fn from(v: &String) -> Self

Converts to this type from the input type.

impl From<String> for ScVal

fn from(v: String) -> Self

Converts to this type from the input type.

impl From<String> for StringObject

fn from(v: String) -> Self

Converts to this type from the input type.

impl From<String> for Val

fn from(v: String) -> Self

Converts to this type from the input type.

impl Ord for String

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,

Restrict a value to a certain interval.

impl PartialEq for String

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for String

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl SorobanArbitrary for String

Available on crate feature testutils only.

type Prototype = ArbitraryString

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

impl ToString for String

fn to_string(&self) -> String

Converts the given value to a String.

impl TryFromVal<Env, &str> for String

type Error = ConversionError

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

impl TryFromVal<Env, ScVal> for String

type Error = ConversionError

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

impl TryFromVal<Env, String> for String

type Error = ConversionError

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

impl TryFromVal<Env, String> for Val

type Error = ConversionError

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

impl TryFromVal<Env, StringObject> for String

type Error = Infallible

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

impl TryFromVal<Env, Val> for String

type Error = ConversionError

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

impl Eq for String