Skip to main content

ClientGuard

Struct ClientGuard 

Source
pub struct ClientGuard { /* private fields */ }
Expand description

A guard that automatically disconnects a ClaudeClient when dropped.

This provides RAII-style resource management for the client connection, similar to Python’s async context manager (async with).

§Examples

use claude_agents_sdk::{ClaudeClient, ClientGuard};
use tokio_stream::StreamExt;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut client = ClaudeClient::new(None);
    client.connect().await?;

    // Create guard - client will be disconnected when guard is dropped
    let mut guard = ClientGuard::new(client);

    guard.client_mut().query("Hello!").await?;
    let (response, _) = guard.client_mut().receive_response().await?;
    println!("{}", response);

    // Client automatically disconnected when guard goes out of scope
    Ok(())
}

Or using the convenience method:

use claude_agents_sdk::ClaudeClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut client = ClaudeClient::new(None);
    client.connect().await?;

    let guard = client.into_guard();
    // Use guard.client() for all operations
    // Automatically disconnects on drop

    Ok(())
}

Implementations§

Source§

impl ClientGuard

Source

pub fn new(client: ClaudeClient) -> Self

Create a new guard for the client.

§Note

If called outside of a Tokio runtime context, the guard will still work but automatic disconnect on drop will be skipped (with a warning logged).

Source

pub fn client(&self) -> &ClaudeClient

Get a reference to the client.

Source

pub fn client_mut(&mut self) -> &mut ClaudeClient

Get a mutable reference to the client.

Source

pub fn into_inner(self) -> ClaudeClient

Take ownership of the client, preventing automatic disconnect.

Trait Implementations§

Source§

impl Drop for ClientGuard

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

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, 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