Struct ShellSessionReadArgs 

pub struct ShellSessionReadArgs {
    pub session_id: String,
    pub format: OutputFormat,
    pub consume: bool,
    pub wait_ms: u64,
    pub min_bytes: usize,
    pub wait_for_pattern: Option<String>,
    pub wait_for_stable_ms: Option<u64>,
}

Arguments for reading session output

Fields

session_id: String

Session ID

format: OutputFormat

Output format: raw, screen, both, or stripped

consume: bool

Whether to consume (clear) the buffer after reading (default: true)

wait_ms: u64

Maximum wait time for new output in milliseconds (0 = no wait)

min_bytes: usize

Minimum bytes to wait for (with wait_ms timeout)

wait_for_pattern: Option<String>

Wait until this pattern appears in the screen output (e.g., “❯” or “$ “) Takes precedence over wait_ms if both are specified

wait_for_stable_ms: Option<u64>

Wait until screen output stabilizes (no changes for this many ms) Useful for waiting until a TUI finishes rendering

Trait Implementations

impl Clone for ShellSessionReadArgs

fn clone(&self) -> ShellSessionReadArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShellSessionReadArgs

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ShellSessionReadArgs

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ShellSessionReadArgs

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.