Skip to main content

ParamType

Enum ParamType 

Source
pub enum ParamType {
Show 14 variants Bytes, Integer, Boolean, Unit, UtxoRef, Address, Utxo, AnyAsset, List(Box<ParamType>), Tuple(Vec<ParamType>), Map(Box<ParamType>), Record(Vec<(String, ParamType)>), Variant(Vec<VariantCase>), Unknown(Value),
}
Expand description

Type of a transaction parameter.

This enum represents the various types that transaction parameters can have, including primitives, compound types, and references to TX3 core types. It is built from the TII params JSON schema by ParamType::from_json_schema, which never fails — any shape it does not recognize becomes ParamType::Unknown.

Variants§

§

Bytes

Byte array type (hex-encoded).

§

Integer

Integer type (signed or unsigned).

§

Boolean

Boolean type.

§

Unit

Unit type ({ "type": "null" }).

§

UtxoRef

UTXO reference in format 0x[64hex]#[index].

§

Address

Bech32-encoded blockchain address.

§

Utxo

A resolved UTxO object.

§

AnyAsset

An asset identified at runtime by policy and name.

§

List(Box<ParamType>)

Homogeneous, variable-length sequence (array + items).

§

Tuple(Vec<ParamType>)

Fixed-length, positionally-typed sequence (array + prefixItems).

§

Map(Box<ParamType>)

String-keyed homogeneous map (object + additionalProperties).

§

Record(Vec<(String, ParamType)>)

User-defined record (object + properties), (field name, type) in declared order (the schema’s required array, which tx3c emits in source order — properties is alphabetized and must not drive field order). Encoding maps the user’s by-name object to positional fields.

§

Variant(Vec<VariantCase>)

User-defined tagged union (oneOf), externally tagged.

§

Unknown(Value)

A schema shape that could not be interpreted; carries the raw schema.

Implementations§

Source§

impl ParamType

Source

pub fn field(&self, name: &str) -> Option<&ParamType>

Looks up a field type by name in a ParamType::Record; None for any other kind or an absent field.

Source

pub fn from_json_schema( schema: &Value, components: &HashMap<String, Value>, ) -> ParamType

Creates a parameter type from a JSON schema node.

Interprets every shape tx3c can emit (see the SDK spec’s api-surface/args.md). It never fails: an unrecognized shape — including a bare string, an unresolved object, or an unknown $ref — becomes ParamType::Unknown carrying the raw schema.

§Arguments
  • schema - The JSON schema node to interpret
  • components - The TII’s components.schemas table, used to resolve #/components/schemas/<Name> references to user-defined types

Trait Implementations§

Source§

impl Clone for ParamType

Source§

fn clone(&self) -> ParamType

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ParamType

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more