Struct ShellSessionReadResult 

pub struct ShellSessionReadResult {
    pub session_id: String,
    pub raw: Option<String>,
    pub screen: Option<ScreenState>,
    pub buffer_size: usize,
    pub truncated: bool,
    pub state: SessionState,
    pub pattern_matched: Option<bool>,
    pub stabilized: Option<bool>,
}

Result of reading from a session

Fields

session_id: String

Session ID

raw: Option<String>

Raw output (if requested, may be with or without ANSI codes based on format)

screen: Option<ScreenState>

Screen state (if requested)

buffer_size: usize

Bytes remaining in buffer (if not consumed)

truncated: bool

Whether data was truncated due to buffer overflow

state: SessionState

Current session state

pattern_matched: Option<bool>

Whether wait_for_pattern matched (None if pattern wasn’t requested)

stabilized: Option<bool>

Whether output stabilized within timeout (None if wait_for_stable_ms wasn’t requested)

Trait Implementations

impl Clone for ShellSessionReadResult

fn clone(&self) -> ShellSessionReadResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShellSessionReadResult

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

Formats the value using the given formatter.

impl JsonSchema for ShellSessionReadResult

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.

impl Serialize for ShellSessionReadResult

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.