Struct ClientBuilder

Source
pub struct ClientBuilder<T: Transport> { /* private fields */ }
Expand description

Builder for creating configured Client instances.

The ClientBuilder provides a fluent API for configuring and creating MCP clients with specific settings.

Implementations§

Source§

impl<T: Transport> ClientBuilder<T>

Source

pub fn new(transport: T) -> Self

Creates a new client builder.

§Arguments
  • transport - The transport to use for communication with the server
§Returns

A new ClientBuilder instance

Source

pub fn set_protocol_version(self, protocol_version: ProtocolVersion) -> Self

Sets the protocol version for the client.

§Arguments
  • protocol_version - The protocol version to use
§Returns

The modified builder instance

Source

pub fn set_client_info( self, name: impl Into<String>, version: impl Into<String>, ) -> Self

Sets the client information.

§Arguments
  • name - The client name
  • version - The client version
§Returns

The modified builder instance

Source

pub fn set_capabilities(self, capabilities: ClientCapabilities) -> Self

Sets the client capabilities.

§Arguments
  • capabilities - The client capabilities
§Returns

The modified builder instance

Source

pub fn with_secure_value( self, key: impl Into<String>, value: SecureValue, ) -> Self

Adds a secure value for substitution in tool arguments.

§Arguments
  • key - The key for the secure value
  • value - The secure value
§Returns

The modified builder instance

Source

pub fn use_strict(self) -> Self

Enables strict mode, which requires initialization before operations.

§Returns

The modified builder instance

Source

pub fn with_strict(self, strict: bool) -> Self

Sets the strict mode flag.

§Arguments
  • strict - Whether to enable strict mode
§Returns

The modified builder instance

Source

pub fn build(self) -> Client<T>

Builds the client with the configured settings.

§Returns

A new Client instance

Auto Trait Implementations§

§

impl<T> Freeze for ClientBuilder<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for ClientBuilder<T>
where T: RefUnwindSafe,

§

impl<T> Send for ClientBuilder<T>

§

impl<T> Sync for ClientBuilder<T>

§

impl<T> Unpin for ClientBuilder<T>
where T: Unpin,

§

impl<T> UnwindSafe for ClientBuilder<T>
where T: UnwindSafe,

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T