Skip to main content

Client

Struct Client 

Source
pub struct Client<B = Hyper> { /* private fields */ }
Expand description

A client for one model server.

Cheap to clone; clones share the connection pool and what was learned about the server, such as that it rejects optional fields.

B is the HTTP backend: the built-in Hyper unless the builder is given another. Most code never names it and writes Client.

use svir::prelude::*;

let client = Client::openai("http://127.0.0.1:1234").build()?;
let request = Request::new("qwen3-27b").user("Explain ownership in one paragraph.");

let mut stream = client.stream(&request).await?;
while let Some(event) = stream.next().await {
    if let Event::Text(delta) = event? {
        print!("{delta}");
    }
}

Implementations§

Source§

impl Client

Source

pub fn openai(url: impl Into<String>) -> ClientBuilder

A client for an OpenAI-compatible server at url, which may be written with or without /v1. Finish with build.

Source§

impl<B: Backend> Client<B>

Source

pub async fn stream( &self, request: impl Borrow<Request>, ) -> Result<EventStream<B>, Error>

Sends request and returns the answer as a stream of events.

Dropping the stream cancels the request and closes the connection.

Source

pub async fn complete( &self, request: impl Borrow<Request>, ) -> Result<Completion, Error>

Sends request and returns the whole answer.

Source

pub async fn send( &self, request: impl Borrow<Request>, ) -> Result<RawStream<B>, Error>

Sends request and returns the server’s bytes unchanged, after status mapping and compatibility handling: for a proxy that relays the stream and reads it on the way past with a Decoder. Layers work on events, so they do not apply here.

Source

pub async fn list_models(&self) -> Result<Vec<Model>, Error>

Lists the models the server reports, unfiltered.

Trait Implementations§

Source§

impl<B> Clone for Client<B>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<B> Debug for Client<B>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<B = Hyper> !RefUnwindSafe for Client<B>

§

impl<B = Hyper> !UnwindSafe for Client<B>

§

impl<B> Freeze for Client<B>
where Arc<Inner<B>>: Freeze,

§

impl<B> Send for Client<B>
where Arc<Inner<B>>: Send,

§

impl<B> Sync for Client<B>
where Arc<Inner<B>>: Sync,

§

impl<B> Unpin for Client<B>
where Arc<Inner<B>>: Unpin,

§

impl<B> UnsafeUnpin for Client<B>
where Arc<Inner<B>>: UnsafeUnpin,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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