Enum Effect 

pub enum Effect {
    HttpGet {
        id: u32,
        url: String,
        headers: Vec<(String, String)>,
    },
    HttpPost {
        id: u32,
        url: String,
        body: String,
        content_type: Option<String>,
        headers: Vec<(String, String)>,
    },
    Sleep {
        id: u32,
        duration_ms: u64,
    },
}

Effect request from plugin to host

Plugins cannot perform I/O directly (sandboxed), so they request the host to perform operations on their behalf.

Example Flow

Plugin: execute(args) -> Effect::HttpGet { id: 1, url: "..." }
Host:   performs HTTP GET asynchronously
Host:   plugin_resume(1, EffectResult::Http { ... })
Plugin: resume(1, result) -> Success("done")

Variants

HttpGet

HTTP GET request

Fields

id: u32

Unique ID for this effect (used in resume)

url: String

URL to fetch

headers: Vec<(String, String)>

Optional headers

HttpPost

HTTP POST request

Fields

id: u32

Unique ID for this effect

url: String

URL to post to

body: String

Request body

content_type: Option<String>

Content type (default: application/json)

headers: Vec<(String, String)>

Optional headers

Sleep

Sleep/delay

Fields

id: u32

Unique ID for this effect

duration_ms: u64

Duration in milliseconds

Implementations

impl Effect

pub fn id(&self) -> u32

Get the effect ID

pub fn http_get(id: u32, url: impl Into<String>) -> Effect

Create an HTTP GET effect

pub fn http_post( id: u32, url: impl Into<String>, body: impl Into<String>, ) -> Effect

Create an HTTP POST effect

pub fn sleep(id: u32, duration_ms: u64) -> Effect

Create a sleep effect

Trait Implementations

impl Clone for Effect

fn clone(&self) -> Effect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Effect

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Effect

fn deserialize<__D>( __deserializer: __D, ) -> Result<Effect, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Effect

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

where __S: Serializer,

Serialize this value into the given Serde serializer.