Session

Struct Session 

Source
pub struct Session {
    pub id: String,
    pub options: SessionOptions,
    /* private fields */
}
Expand description

A conversation session with Claude

Session provides a simplified interface for multi-turn conversations with Claude. It wraps the underlying ClaudeClient and provides easier-to-use methods.

§Example

use claude_agent_sdk::v2::{create_session, SessionOptions};

#[tokio::main]
async fn example() -> Result<(), Box<dyn std::error::Error>> {
    let mut session = create_session(SessionOptions::default()).await?;

    // Send a message
    session.send("What is 2 + 2?").await?;

    // Receive all responses
    let messages = session.receive().await?;
    for msg in messages {
        println!("Message: {:?}", msg);
    }

    // Close the session
    session.close().await?;

    Ok(())
}

Fields§

§id: String

Unique session identifier

§options: SessionOptions

Session options

Implementations§

Source§

impl Session

Source

pub async fn send(&mut self, message: impl Into<String>) -> Result<()>

Send a message to Claude

This method sends a user message to Claude and queues it for processing. Call receive() to get Claude’s response.

§Arguments
  • message - The message text to send
§Example
session.send("Hello, Claude!").await?;
§Errors

Returns an error if:

  • The message is empty
  • Network connection fails
  • Session is closed
Source

pub async fn receive(&self) -> Result<Vec<V2Message>>

Receive messages from Claude

This method returns all pending messages from Claude since the last send() call. Messages are returned until a Result message is encountered (end of turn).

§Returns

A vector of V2Message objects

§Example
let messages = session.receive().await?;
for msg in messages {
    if let Some(text) = msg.as_text() {
        println!("Claude: {}", text);
    }
}
Source

pub async fn model(&self) -> Option<String>

Get the model being used for this session

Source

pub async fn is_connected(&self) -> bool

Check if the session is still connected

Source

pub async fn close(self) -> Result<()>

Close the session

This method closes the connection to Claude and releases any resources.

§Example
session.close().await?;
println!("Session closed");

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more