Enum StreamFormat

pub enum StreamFormat {
    Text,
    Json,
    StreamJson,
}

Output format for Claude CLI responses

Controls how the Claude CLI formats its output, affecting both parsing and the amount of metadata available in responses.

Examples

use claude_sdk_rs_core::StreamFormat;

// For simple text responses (default)
let format = StreamFormat::Text;

// For structured responses with metadata
let format = StreamFormat::Json;

// For streaming applications with line-delimited JSON
let format = StreamFormat::StreamJson;

Variants

Text

Plain text output without metadata

This is the default format. Claude CLI returns only the text content of the response, making it simple to use but without access to metadata like costs, session IDs, or token usage.

Json

Structured JSON output with full metadata

Claude CLI returns a complete JSON object containing the response text along with metadata such as:

• Session ID
• Cost information
• Token usage statistics
• Timing information

StreamJson

Line-delimited JSON messages for streaming

Each line contains a separate JSON message, allowing for real-time processing of the response as it’s generated. Useful for implementing streaming interfaces or progress indicators.

Trait Implementations

impl Clone for StreamFormat

fn clone(&self) -> StreamFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamFormat

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

Formats the value using the given formatter.

impl Default for StreamFormat

fn default() -> StreamFormat

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StreamFormat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StreamFormat

fn eq(&self, other: &StreamFormat) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for StreamFormat

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for StreamFormat

impl StructuralPartialEq for StreamFormat