Struct homestar_invocation::task::instruction::Instruction

pub struct Instruction<'a, T> { /* private fields */ }

Instruction to be executed.

Example

use homestar_invocation::{
    task::{
        instruction::{Ability, Input},
        Instruction,
    },
    Unit,
 };
use libipld::Ipld;
use url::Url;

let wasm = "bafybeia32q3oy6u47x624rmsmgrrlpn7ulruissmz5z2ap6alv7goe7h3q".to_string();
let resource = Url::parse(format!("ipfs://{wasm}").as_str()).unwrap();

let instr = Instruction::unique(
    resource,
    Ability::from("wasm/run"),
    Input::<Unit>::Ipld(Ipld::List(vec![Ipld::Bool(true)]))
);

We can also set-up an Instruction with a Deferred input to await on:

use homestar_invocation::{
    pointer::{Await, AwaitResult},
    task::{
        instruction::{Ability, Input, Nonce},
        Instruction,
    },
    Pointer, Unit,
 };
use libipld::{cid::{multihash::{Code, MultihashDigest}, Cid}, Ipld, Link};
use url::Url;
let wasm = "bafybeia32q3oy6u47x624rmsmgrrlpn7ulruissmz5z2ap6alv7goe7h3q".to_string();
let resource = Url::parse(format!("ipfs://{wasm}").as_str()).expect("IPFS URL");
let h = Code::Blake3_256.digest(b"beep boop");
let cid = Cid::new_v1(0x55, h);
let link: Link<Cid> = Link::new(cid);
let awaited_instr = Pointer::new_from_link(link);

let instr = Instruction::new_with_nonce(
    resource,
    Ability::from("wasm/run"),
    Input::<Unit>::Deferred(Await::new(awaited_instr, AwaitResult::Ok)),
    Nonce::generate()
);

// And covert it to a pointer:
let ptr = Pointer::try_from(instr).unwrap();

Implementations

impl<T> Instruction<'_, T>

pub fn new(rsc: Url, ability: Ability, input: Input<T>) -> Self

Create a new Instruction with an empty Nonce.

pub fn new_with_nonce( rsc: Url, ability: Ability, input: Input<T>, nnc: Nonce ) -> Self

Create a new Instruction with a given Nonce.

pub fn unique(rsc: Url, ability: Ability, input: Input<T>) -> Self

Create a unique Instruction, with a default Nonce generator.

pub fn resource(&self) -> &Url

Return Instruction resource, i.e. Url.

pub fn op(&self) -> &Ability

Return Ability associated with op.

pub fn input(&self) -> &Input<T>

Return Instruction Input.

pub fn nonce(&self) -> &Nonce

Return Nonce reference.

Trait Implementations

impl<'a, T: Clone> Clone for Instruction<'a, T>

fn clone(&self) -> Instruction<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T> DagCbor for Instruction<'a, T>

where Ipld: From<T>,

fn to_cid(self) -> Result<Cid, Error<Unit>>

Performs the conversion from an owned Self to Cid.

fn to_dag_json(self) -> Result<Vec<u8>, Error<Unit>>

Serialize Self to JSON bytes.

fn to_dagjson_string(self) -> Result<String, Error<Unit>>

Serialize Self to JSON String.

fn to_cbor(self) -> Result<Vec<u8>, Error<Unit>>

Serialize Self to CBOR bytes.

fn to_cbor_file(self, filename: String) -> Result<(), Error<Unit>>

Serialize Self to a CBOR file.

impl<'a, T: Debug> Debug for Instruction<'a, T>

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

Formats the value using the given formatter.

impl<'de, 'a, T> Deserialize<'de> for Instruction<'a, T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<Instruction<'_, T>> for Ipld

where Ipld: From<T>,

fn from(instruction: Instruction<'_, T>) -> Self

Converts to this type from the input type.

impl<'a, T> From<Instruction<'a, T>> for RunInstruction<'a, T>

fn from(instruction: Instruction<'a, T>) -> Self

Converts to this type from the input type.

impl<'a, T> JsonSchema for Instruction<'a, T>

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<'a, T: PartialEq> PartialEq for Instruction<'a, T>

fn eq(&self, other: &Instruction<'a, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, T> Serialize for Instruction<'a, T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> TryFrom<&Ipld> for Instruction<'_, T>

where T: From<Ipld>,

type Error = Error<Unit>

The type returned in the event of a conversion error.

fn try_from(ipld: &Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<Instruction<'_, T>> for Pointer

where Ipld: From<T>,

type Error = Error<Unit>

The type returned in the event of a conversion error.

fn try_from(instruction: Instruction<'_, T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<Ipld> for Instruction<'_, T>

where T: From<Ipld>,

type Error = Error<Unit>

The type returned in the event of a conversion error.

fn try_from(ipld: Ipld) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, T> TryFrom<RunInstruction<'a, T>> for Instruction<'a, T>

where T: Debug,

type Error = Error<RunInstruction<'a, T>>

The type returned in the event of a conversion error.

fn try_from(run: RunInstruction<'a, T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, T> StructuralPartialEq for Instruction<'a, T>