Struct AgentSurface 

pub struct AgentSurface {

    pub command: Option<String>,
    pub mutates: bool,
    pub allow_unknown_keys: bool,
    pub filter_scope: Option<FilterScope>,
    pub use_active: bool,
    pub select: Vec<String>,
    pub filters: Vec<FilterExpr>,
    pub sort: Option<String>,
    pub dedupe_by: Option<String>,
    pub max_items: usize,
    pub count_only: bool,
    pub streamed: bool,
    pub writes_receipt: bool,
    pub truncate_content: usize,
    pub max_output_bytes: usize,
}

Resolved output-shaping request for the current process.

Fields

command: Option<String>

Subcommand that emitted the envelope, as crate::cli::Commands::agent_surface_slug reports it.

CONTEXT, never a knob: it tells alias suppression which subcommand’s contract applies, and therefore takes no part in Self::is_noop. A surface carrying only a command name still changes nothing.

mutates: bool

Whether the subcommand can change durable state, as crate::cli::Commands::mutates reports it.

CONTEXT, never a knob, so it takes no part in Self::is_noop. The gate reads it to stay silent after a write: refusing at output time would report failure for an operation that already succeeded.

allow_unknown_keys: bool

Escape hatch for --allow-unknown-keys: tolerate a key nothing carries.

CONTEXT, never a knob. On its own it changes no envelope; it only widens what the gate accepts.

filter_scope: Option<FilterScope>

What --filter-scope declared the predicate may observe.

CONTEXT, never a knob: on its own it changes no envelope, it only tells the gate which reading the caller meant.

use_active: bool

Whether --use-active accepted an ambient target on purpose.

CONTEXT, never a knob, so it takes no part in Self::is_noop. It dispenses a mutating verb from naming its target in the argv, and target records that it was used.

select: Vec<String>

Keys kept by --select / --fields, in the requested order.

filters: Vec<FilterExpr>

Predicates from --filter, conjoined with AND.

sort: Option<String>

Sort key from --sort.

dedupe_by: Option<String>

Dedup key from --dedupe-by.

max_items: usize

Cap on emitted result elements (--max-items); 0 disables it.

count_only: bool

Replace the payload with a count (--count-only).

streamed: bool

Whether the subcommand emits one self-contained record per line.

GAP-SG-209: crate::cli::Commands::streams reports it, and gate refuses the knobs that would otherwise be applied once per record.

writes_receipt: bool

Whether the subcommand actually persists, so its envelope is a receipt.

CONTEXT, never a knob. GAP-SG-206: crate::cli::Commands::persists reports it, and --count-only is suppressed rather than honoured when it is set. DISTINCT from Self::mutates, which answers true for config list-keys and every other command that merely failed to make the read-only list.

truncate_content: usize

Cap on string length in characters (--truncate-content); 0 disables it.

max_output_bytes: usize

Cap on the serialized envelope in bytes (--max-output-bytes); 0 disables it.

Implementations

impl AgentSurface

pub fn is_noop(&self) -> bool

true when no knob is set and apply must be a no-op.

Trait Implementations

impl Clone for AgentSurface

fn clone(&self) -> AgentSurface

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentSurface

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

Formats the value using the given formatter.

impl Default for AgentSurface

fn default() -> AgentSurface

Returns the “default value” for a type.