Struct SizedSafeString 

pub struct SizedSafeString<const MAX_LEN: usize>(/* private fields */);

A String wrapper which enforces certain constraints to ensure it is safely displayable as part of a transaction without confusing the user. Only printable ASCII is allowed, and the length is limited.

UniversalWallet implementation is forbidden on std::String by default, to avoid the possibility of untrusted input supplying highly confusing text that tricks users into misunderstanding the transaction they are signing. SafeString enforces some constraints to mitigate this risk. If you need to encode a large data blob such as a hex string, use a Vec<u8> with the [sov_wallet(display = "hex")] attribute (or any of the other display styles). Avoid raw Strings if possible. If an actual String is absolutely necessary, then a newtype wrapper can be used, on which UniversalWallet is derived manually.

Implementations

impl<const MAX_LEN: usize> SizedSafeString<MAX_LEN>

pub fn as_str(&self) -> &str

pub const fn max_len(&self) -> usize

A convenience method to get the maximum length of SafeString instance

pub const fn new() -> Self

Return an empty SafeString. This method does not allocate

pub fn len(&self) -> usize

Returns the length (not capacity or max_length) of the string in bytes

pub fn is_empty(&self) -> bool

Returns true if the string is empty

pub fn try_push(&mut self, c: char) -> Result<(), SchemaStringError>

Appends the given char`` to the end of this SizedSafeString` if possible.

pub const fn is_valid_char(c: char) -> bool

Returns true if the character is a valid member of SizedSafeString

Trait Implementations

impl<const MAX_LEN: usize> AsRef<[u8]> for SizedSafeString<MAX_LEN>

fn as_ref(&self) -> &[u8]

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

impl<const MAX_LEN: usize> AsRef<str> for SizedSafeString<MAX_LEN>

fn as_ref(&self) -> &str

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

impl<const MAX_LEN: usize> BorshDeserialize for SizedSafeString<MAX_LEN>

fn deserialize_reader<R: Read>(reader: &mut R) -> Result<Self>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

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

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl<const MAX_LEN: usize> BorshSerialize for SizedSafeString<MAX_LEN>

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl<const MAX_LEN: usize> Clone for SizedSafeString<MAX_LEN>

fn clone(&self) -> SizedSafeString<MAX_LEN>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const MAX_LEN: usize> Debug for SizedSafeString<MAX_LEN>

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

Formats the value using the given formatter.

impl<const MAX_LEN: usize> Default for SizedSafeString<MAX_LEN>

fn default() -> SizedSafeString<MAX_LEN>

Returns the “default value” for a type.

impl<const MAX_LEN: usize> Display for SizedSafeString<MAX_LEN>

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

Formats the value using the given formatter.

impl<const MAX_LEN: usize> From<SizedSafeString<MAX_LEN>> for String

fn from(value: SizedSafeString<MAX_LEN>) -> Self

Converts to this type from the input type.

impl<const MAX_LEN: usize> FromStr for SizedSafeString<MAX_LEN>

type Err = SchemaStringError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<const MAX_LEN: usize> Hash for SizedSafeString<MAX_LEN>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const MAX_LEN: usize> Ord for SizedSafeString<MAX_LEN>

fn cmp(&self, other: &SizedSafeString<MAX_LEN>) -> 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<const MAX_LEN: usize> PartialEq for SizedSafeString<MAX_LEN>

fn eq(&self, other: &SizedSafeString<MAX_LEN>) -> 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<const MAX_LEN: usize> PartialOrd for SizedSafeString<MAX_LEN>

fn partial_cmp(&self, other: &SizedSafeString<MAX_LEN>) -> 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<'a, const MAX_LEN: usize> TryFrom<&'a str> for SizedSafeString<MAX_LEN>

type Error = SchemaStringError

The type returned in the event of a conversion error.

fn try_from(value: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl<const MAX_LEN: usize> TryFrom<String> for SizedSafeString<MAX_LEN>

type Error = SchemaStringError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl<const MAX_LEN: usize> UniversalWallet for SizedSafeString<MAX_LEN>

fn scaffold() -> Item<IndexLinking>

Generate the “scaffolding” of the item. If the item is a primtive, this is just the corresponding primtive. If the type is composed of other types, this is the container with all links set to Link::Placeholder.

fn get_child_links(_schema: &mut Schema) -> Vec<Link>

Ensure that each type contained in the outer type (i.e. the type of each struct/tuple field) is added to the schema, and return a Link connecting the child to the parent.

fn write_schema(schema: &mut Schema) -> Link

Writes the type to the schema if it is not already present and returns a link to it.

fn make_root_of(schema: &mut Schema)

Writes the type and all its children to the schema, if not already present, and sets the type as a root type. Generates any templates defined on that type.

fn get_child_templates(_schema: &mut Schema) -> TransactionTemplateSet

Empty by default When derived by the macro, builds a template set from annotations on the fields + the field types’ own get_child_templates()

fn make_linkable(schema: &mut Schema) -> Link

Gets a link to the type, writing the type to the schema if necessary.

fn id_override() -> Option<ItemId>

Override the type ID of the item. This should typically not be written by hand. Instead, use the OverrideSchema trait.

impl<const MAX_LEN: usize> Eq for SizedSafeString<MAX_LEN>

impl<const MAX_LEN: usize> StructuralPartialEq for SizedSafeString<MAX_LEN>