Struct Context 

pub struct Context { /* private fields */ }

The context object is used to interact with the Hatchet API from within a task.

Implementations

impl Context

pub async fn parent_output( &self, parent_step_name: &str, ) -> Result<Value, HatchetError>

Get the output of a parent task in a DAG.

let task = hatchet.task("my-task", |_input: EmptyModel, ctx: Context| async move {
    let parent_output = ctx.parent_output("parent_task").await.unwrap();
    Ok(EmptyModel)
});

pub async fn filter_payload(&self) -> Result<Value, HatchetError>

pub async fn log(&self, message: &str) -> Result<(), HatchetError>

Log a line to the Hatchet API. This will send the log line to the Hatchet API and return immediately.

use hatchet_sdk::{Hatchet, EmptyModel};
let hatchet = Hatchet::from_env().await.unwrap();
let task = hatchet.task("my-task", |_input: EmptyModel, ctx: Context| async move {
    ctx.log("Hello, world!").await.unwrap();
    Ok(EmptyModel)
});

pub async fn put_stream( &self, data: impl Into<Vec<u8>>, ) -> Result<(), HatchetError>

Send a stream event to the Hatchet API. Useful for streaming data such as LLM tokens or progress updates from a task to consumers.

use hatchet_sdk::{Hatchet, EmptyModel};
let hatchet = Hatchet::from_env().await.unwrap();
let task = hatchet.task("my-task", |_input: EmptyModel, ctx: Context| async move {
    ctx.put_stream(b"chunk 1".to_vec()).await.unwrap();
    ctx.put_stream(b"chunk 2".to_vec()).await.unwrap();
    Ok(EmptyModel)
});

Trait Implementations

impl Debug for Context

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

Formats the value using the given formatter.