Skip to main content

ClientBuilder

Struct ClientBuilder 

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

Builder for configuring and creating a Procwire client.

Use the fluent API to register handlers and events, then call start() to begin the client lifecycle.

Implementations§

Source§

impl ClientBuilder

Source

pub fn new() -> Self

Create a new client builder.

Source

pub fn handle<F, T, Fut>(self, method: &str, handler: F) -> Self
where F: Fn(T, RequestContext) -> Fut + Send + Sync + 'static, T: DeserializeOwned + Send + 'static, Fut: Future<Output = HandlerResult> + Send + 'static,

Register a method handler with “result” response type.

The handler receives deserialized payload and a context for responding.

Source

pub fn handle_stream<F, T, Fut>(self, method: &str, handler: F) -> Self
where F: Fn(T, RequestContext) -> Fut + Send + Sync + 'static, T: DeserializeOwned + Send + 'static, Fut: Future<Output = HandlerResult> + Send + 'static,

Register a method handler with “stream” response type.

Use ctx.chunk() to send stream chunks and ctx.end() to finish.

Source

pub fn handle_ack<F, T, Fut>(self, method: &str, handler: F) -> Self
where F: Fn(T, RequestContext) -> Fut + Send + Sync + 'static, T: DeserializeOwned + Send + 'static, Fut: Future<Output = HandlerResult> + Send + 'static,

Register a method handler with “ack” response type.

Use ctx.ack() to send the acknowledgment.

Source

pub fn event(self, name: &str) -> Self

Register an event that this client can emit.

Events are fire-and-forget messages to the parent.

Source

pub fn max_concurrent_handlers(self, limit: usize) -> Self

Set the maximum number of concurrent handlers.

When this limit is reached, new requests will be dropped with a warning. Default: 256

Source

pub fn max_pending_frames(self, limit: usize) -> Self

Set the maximum pending frames for backpressure.

When this limit is reached, response methods will wait until backpressure clears or timeout. Default: 1024

Source

pub fn channel_capacity(self, capacity: usize) -> Self

Set the writer channel capacity.

Default: 1024

Source

pub fn backpressure_timeout(self, timeout: Duration) -> Self

Set the backpressure timeout.

Default: 5 seconds

Source

pub async fn start(self) -> Result<Client>

Build and start the client.

This will:

  1. Generate pipe path
  2. Start pipe listener
  3. Send $init to parent (stdout)
  4. Accept parent connection
  5. Start frame processing loop

Trait Implementations§

Source§

impl Default for ClientBuilder

Source§

fn default() -> Self

Returns the “default value” for a 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