Struct soroban_spec_tools::Spec

pub struct Spec(pub Option<Vec<ScSpecEntry>>);

Tuple Fields

0: Option<Vec<ScSpecEntry>>

Implementations

impl Spec

pub fn new(entries: Vec<ScSpecEntry>) -> Self

pub fn from_wasm(wasm: &[u8]) -> Result<Spec, Error>

pub fn parse_base64(base64: &str) -> Result<Spec, Error>

impl Spec

pub fn doc( &self, name: &str, type_: &ScType ) -> Result<Option<&'static str>, Error>

Errors

Could fail to find User Defined Type

pub fn find(&self, name: &str) -> Result<&ScSpecEntry, Error>

Errors

Might return errors

pub fn find_function(&self, name: &str) -> Result<&ScSpecFunctionV0, Error>

Errors

Might return errors

pub fn find_functions( &self ) -> Result<impl Iterator<Item = &ScSpecFunctionV0>, Error>

Errors

pub fn find_error_type( &self, value: u32 ) -> Result<&ScSpecUdtErrorEnumCaseV0, Error>

Errors

pub fn from_string_primitive(s: &str, t: &ScType) -> Result<ScVal, Error>

Errors

Might return errors

pub fn from_string(&self, s: &str, t: &ScType) -> Result<ScVal, Error>

Errors

Might return errors

pub fn from_json(&self, v: &Value, t: &ScType) -> Result<ScVal, Error>

Errors

Might return errors

impl Spec

pub fn xdr_to_json(&self, val: &ScVal, output: &ScType) -> Result<Value, Error>

Errors

Might return Error::InvalidValue

Panics

May panic

pub fn vec_m_to_json<const MAX: u32>( &self, vec_m: &VecM<ScVal, MAX>, type_: &ScType ) -> Result<Value, Error>

Errors

Might return an error

pub fn sc_map_to_json( &self, sc_map: &ScMap, type_: &ScSpecTypeMap ) -> Result<Value, Error>

Errors

Might return an error

pub fn udt_to_json( &self, name: &StringM<60>, sc_obj: &ScVal ) -> Result<Value, Error>

Errors

Might return an error

Panics

May panic

pub fn sc_object_to_json( &self, val: &ScVal, spec_type: &ScType ) -> Result<Value, Error>

Errors

Might return an error

Panics

Some types are not yet supported and will cause a panic if supplied

impl Spec

pub fn arg_value_name(&self, type_: &ScType, depth: usize) -> Option<String>

impl Spec

pub fn example(&self, type_: &ScType) -> Option<String>

Trait Implementations

impl Clone for Spec

fn clone(&self) -> Spec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Spec

fn default() -> Spec

Returns the “default value” for a type.

impl TryInto<Spec> for &[u8]

type Error = FromWasmError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Spec, Self::Error>

Performs the conversion.