Struct ImageGeneration 

pub struct ImageGeneration { /* private fields */ }

Generates a session image and publishes it as a chat artifact.

Implementations

impl ImageGeneration

pub fn new( models: Arc<ModelRouter>, store: SessionFileStore, route: Option<Arc<str>>, ) -> Self

Creates the image capability with the configured model routes and session files. route selects an image model route; None uses the first configured one.

pub fn from_settings<'a>( models: Arc<ModelRouter>, store: SessionFileStore, setting: impl FnOnce(&str) -> Option<&'a FrontendSettingValue>, ) -> Result<Self>

Creates the image capability from its manifest settings, read through setting.

Errors

Returns an error if the model setting is not a string.

Trait Implementations

impl Middleware for ImageGeneration

fn name(&self) -> &'static str

Stable ID used to reject duplicate registrations.

fn register( &self, catalog: &mut Catalog, runtime: &RuntimeContext, ) -> Result<()>

Adds tools to the catalog while the agent is created.

fn frontend(&self, _session_id: &str) -> FrontendContribution

Declares commands and status data that any frontend may render for one session.

fn render(&self, event: &EventMsg, _session_id: &str) -> Option<FrontendBlock>

Renders an event owned by this capability for the destination session.

fn incompatible_middleware(&self) -> &'static [&'static str]

Middleware IDs that cannot share a stack with this configured capability.

fn context_limit(&self, _context_window: i64) -> Option<i64>

Returns the input-token limit this capability enforces for a model context window.

fn prompt_section( &self, _runtime: &RuntimeContext, ) -> Result<Option<PromptSection>>

Contributes one immutable system-prompt section while the agent is created.

fn command<'a>( &'a self, context: MiddlewareCommandContext<'a>, ) -> BoxFuture<'a, Result<MiddlewareCommandOutput>>

Handles a command declared by this middleware’s frontend contribution.

fn session_start<'a>( &'a self, _context: &'a mut SessionStartContext<'_>, ) -> BoxFuture<'a, Result<()>>

Starts or re-enters a session lifecycle.

fn handles_messages(&self) -> bool

Reports whether this middleware is the session’s conversation-message preparer.

fn route_message<'a>( &'a self, _context: &'a mut MessageRouteContext<'_>, ) -> BoxFuture<'a, Result<SubmissionResult>>

Validates and prepares one conversation message for its lifecycle boundary.

fn message_boundary_events(&self, _submission_id: &str) -> Vec<EventMsg>

Produces capability UI cleanup when one queued message reaches its boundary.

fn message_submit<'a>( &'a self, _context: &'a mut MessageSubmitContext<'_>, ) -> BoxFuture<'a, Result<()>>

Intercepts a prepared conversation message at its delivery boundary.

fn active_command<'a>( &'a self, _context: &'a mut ActiveCommandContext<'_>, ) -> BoxFuture<'a, Result<Option<SubmissionResult>>>

Handles a capability command while a turn is active.

fn pre_model<'a>( &'a self, _context: &'a mut ModelContext<'_>, ) -> BoxFuture<'a, Result<()>>

Mutates durable context before the next model request is assembled.

fn model_request<'a>( &'a self, _context: &'a mut ModelRequestContext<'_>, ) -> BoxFuture<'a, Result<()>>

Applies request-only context after every durable transform has completed.

fn tool_exposure<'a>( &'a self, _context: &'a mut ToolExposureContext<'_>, ) -> BoxFuture<'a, Result<()>>

Hides registered tools whose capability is unavailable at this boundary.

fn pre_tool_use<'a>( &'a self, _context: &'a mut PreToolUseContext<'_>, ) -> BoxFuture<'a, Result<()>>

Intercepts one normalized tool call before authorization and persistence.

fn permission_request<'a>( &'a self, _context: &'a mut PermissionRequestContext<'_>, ) -> BoxFuture<'a, Result<()>>

Decides whether an approval request should be deferred, allowed, or denied.

fn post_tool_use<'a>( &'a self, _context: &'a mut PostToolUseContext<'_>, ) -> BoxFuture<'a, Result<()>>

Transforms model-visible feedback after a tool has executed.

fn pre_compact<'a>( &'a self, _context: &'a mut CompactContext<'_>, ) -> BoxFuture<'a, Result<()>>

Intercepts context immediately before compaction and may stop the active turn.

fn prepare_compacted_input( &self, _original: ModelInput<'_>, _compacted: &mut Vec<Arc<Value>>, )

Repairs or discards capability-owned projections before compacted input is committed. The original input is read-only; changes are validated before the rewrite is saved.

fn post_compact<'a>( &'a self, _context: &'a mut CompactContext<'_>, ) -> BoxFuture<'a, Result<()>>

Intercepts the committed compacted context and may stop the active turn.

fn stop<'a>( &'a self, _context: &'a mut StopContext<'_>, ) -> BoxFuture<'a, Result<()>>

Decides whether a naturally stopped model should continue once more.

fn turn_end<'a>( &'a self, _context: &'a mut TurnEndContext<'_>, ) -> BoxFuture<'a, Result<()>>

Observes terminal bookkeeping for a completed or aborted turn.

fn session_end<'a>( &'a self, _runtime: &'a RuntimeContext, ) -> BoxFuture<'a, Result<()>>

Releases session-local state when the agent runtime stops.

fn main_agent_only(&self) -> bool

Keeps this capability out of child agents created from the root’s configuration.

fn has_background_work<'a>( &'a self, _session_id: &'a str, ) -> BoxFuture<'a, Result<bool>>

Reports work this capability still runs for the session outside an active turn.