Skip to main content

Command

Enum Command 

Source
pub enum Command {
    Infer {
        prompt: String,
        max_tokens: u32,
    },
    Open {
        path: String,
    },
    Slice {
        handle: Handle,
        offset: u64,
        len: u64,
    },
    Emit {
        progress: Value,
    },
    Done {
        result: Value,
    },
    Fail {
        code: String,
        message: String,
    },
}
Expand description

What a guest asks the host to do, returned from its init/step exports.

Variants§

§

Infer

Run a prompt against the job’s model.

Fields

§prompt: String

The prompt to generate from.

§max_tokens: u32

Upper bound on tokens generated. A guest can also end generation early by returning TokenAction::Stop from its on_token export.

§

Open

Open a file. Capability-checked against the job’s spec.

Yields a handle and a length rather than contents — see the crate docs on why bulk data does not cross this boundary.

Fields

§path: String

Path to open. Denied unless the spec grants read access to it.

§

Slice

Pull one bounded window of an open file into guest memory.

The guest picks len, so the guest sets its own memory ceiling.

Fields

§handle: Handle

Handle from a previous Command::Open.

§offset: u64

Byte offset to read from. u64 so that files far larger than a guest could hold remain fully addressable.

§len: u64

Maximum bytes to return. The host may return fewer; see Event::Sliced.

§

Emit

Report progress to whoever is watching the job’s event stream.

Fields

§progress: Value

Arbitrary JSON, forwarded verbatim to the job’s subscribers.

§

Done

Finish successfully with this payload.

Fields

§result: Value

The job’s result, shaped by the spec’s declared output.

§

Fail

Give up. The job ends with this code and message, and no result.

Fields

§code: String

Machine-readable code; see error_codes.

§message: String

Human-readable explanation.

Trait Implementations§

Source§

impl Clone for Command

Source§

fn clone(&self) -> Command

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 Command

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Command

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Command

Source§

fn eq(&self, other: &Command) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Command

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Command

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.