Struct MiddlewareResult 

pub struct MiddlewareResult<T> { /* private fields */ }

What a Middleware returns.

Examples

use moonlit_pdk::{MiddlewareResult, NoOutput};

let ok = MiddlewareResult::ok(NoOutput {}).with_warning("`force` is deprecated");
assert!(ok.is_success());
assert_eq!(ok.warnings(), ["`force` is deprecated"]);

let failed: MiddlewareResult<NoOutput> = MiddlewareResult::failure("tag already exists");
assert!(!failed.is_success());
assert_eq!(failed.error_message(), Some("tag already exists"));

Implementations

impl<T: Serialize> MiddlewareResult<T>

pub fn ok(output: T) -> Self

A successful outcome carrying the middleware’s typed output. Use NoOutput for middlewares that publish nothing.

impl<T> MiddlewareResult<T>

pub fn failure(msg: impl Into<String>) -> Self

A failed outcome; carries no output.

pub fn with_warning(self, msg: impl Into<String>) -> Self

pub fn is_success(&self) -> bool

Whether the middleware succeeded. Useful in sdk::testing unit tests.

pub fn error_message(&self) -> Option<&str>

The failure message, if this result is a failure.

pub fn warnings(&self) -> &[String]

Warnings attached to this result.

impl<T: Serialize> MiddlewareResult<T>

pub fn into_wit(self) -> MiddlewareResult

Convert to the WIT record. The typed output is serialized to a JSON object and spread into the (key, json-text) output list (the field names become the map keys, so steps.NAME.outputs.<field> resolves). A non-object output or a serialization error degrades to a loud failure.