Skip to main content

ServiceClient

Struct ServiceClient 

Source
pub struct ServiceClient<T> { /* private fields */ }
Expand description

Client for this service.

Generic over T: ClientTransport. For gRPC (HTTP/2), use Http2Connection — it has honest poll_ready and composes with tower::balance for multi-connection load balancing. For Connect over HTTP/1.1 (or unknown protocol), use HttpClient.

§Example (gRPC / HTTP/2)

use connectrpc::client::{Http2Connection, ClientConfig};
use connectrpc::Protocol;

let uri: http::Uri = "http://localhost:8080".parse()?;
let conn = Http2Connection::connect_plaintext(uri.clone()).await?.shared(1024);
let config = ClientConfig::new(uri).with_protocol(Protocol::Grpc);

let client = ServiceClient::new(conn, config);
let response = client.subscribe(request).await?;

§Example (Connect / HTTP/1.1 or ALPN)

use connectrpc::client::{HttpClient, ClientConfig};

let http = HttpClient::plaintext();  // cleartext http:// only
let config = ClientConfig::new("http://localhost:8080".parse()?);

let client = ServiceClient::new(http, config);
let response = client.subscribe(request).await?;

§Working with the response

Unary calls return UnaryResponse<OwnedView<FooView>>. The OwnedView derefs to the view, so field access is zero-copy:

let resp = client.subscribe(request).await?.into_view();
let name: &str = resp.name;  // borrow into the response buffer

If you need the owned struct (e.g. to store or pass by value), use into_owned():

let owned = client.subscribe(request).await?.into_owned();

Implementations§

Source§

impl<T> ServiceClient<T>

Source

pub fn new(transport: T, config: ClientConfig) -> Self

Create a new client with the given transport and configuration.

Source

pub fn config(&self) -> &ClientConfig

Get the client configuration.

Source

pub fn config_mut(&mut self) -> &mut ClientConfig

Get a mutable reference to the client configuration.

Source

pub async fn subscribe( &self, request: SubscribeRequest, ) -> Result<ServerStream<T::ResponseBody, SubscribeResponseView<'static>>, ConnectError>

Call the Subscribe RPC. Sends a request to /sql.v1.Service/Subscribe.

Source

pub async fn subscribe_with_options( &self, request: SubscribeRequest, options: CallOptions, ) -> Result<ServerStream<T::ResponseBody, SubscribeResponseView<'static>>, ConnectError>

Call the Subscribe RPC with explicit per-call options. Options override ClientConfig defaults.

Source

pub async fn query( &self, request: QueryRequest, ) -> Result<UnaryResponse<OwnedView<QueryResponseView<'static>>>, ConnectError>

Call the Query RPC. Sends a request to /sql.v1.Service/Query.

Source

pub async fn query_with_options( &self, request: QueryRequest, options: CallOptions, ) -> Result<UnaryResponse<OwnedView<QueryResponseView<'static>>>, ConnectError>

Call the Query RPC with explicit per-call options. Options override ClientConfig defaults.

Source

pub async fn tables( &self, request: TablesRequest, ) -> Result<UnaryResponse<OwnedView<TablesResponseView<'static>>>, ConnectError>

Call the Tables RPC. Sends a request to /sql.v1.Service/Tables.

Source

pub async fn tables_with_options( &self, request: TablesRequest, options: CallOptions, ) -> Result<UnaryResponse<OwnedView<TablesResponseView<'static>>>, ConnectError>

Call the Tables RPC with explicit per-call options. Options override ClientConfig defaults.

Trait Implementations§

Source§

impl<T: Clone> Clone for ServiceClient<T>

Source§

fn clone(&self) -> ServiceClient<T>

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

Auto Trait Implementations§

§

impl<T> !Freeze for ServiceClient<T>

§

impl<T> !RefUnwindSafe for ServiceClient<T>

§

impl<T> Send for ServiceClient<T>
where T: Send,

§

impl<T> Sync for ServiceClient<T>
where T: Sync,

§

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

§

impl<T> UnsafeUnpin for ServiceClient<T>
where T: UnsafeUnpin,

§

impl<T> !UnwindSafe for ServiceClient<T>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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 = 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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