Skip to main content

GrpcApi

Struct GrpcApi 

Source
pub struct GrpcApi<H> { /* private fields */ }
Expand description

Builder for the tonic task API.

Authentication and metrics are optional. server installs the public message-size limit.

§Example

let svc = GrpcApi::new(adapter).server();
solti_api::tonic::transport::Server::builder()
    .add_service(svc)
    .serve("0.0.0.0:50052".parse()?)
    .await?;

§See Also

Implementations§

Source§

impl<H> GrpcApi<H>
where H: ApiHandler,

Source

pub fn new(handler: Arc<H>) -> Self

Creates a gRPC API for one handler.

Source

pub fn with_auth(self, token: Token) -> Self

Requires a bearer token on every call.

The expected metadata is authorization: Bearer <token>. Missing or invalid credentials return Unauthenticated. Rejected calls do not reach the handler. Authentication is disabled when this method is not called.

Source

pub fn with_metrics(self, metrics: ApiMetricsHandle) -> Self

Attaches a metrics backend.

The default backend ignores every update.

Source

pub fn server(self) -> GrpcServer<H>

Builds the configured gRPC service.

Encoded and decoded messages are limited to MAX_REQUEST_BYTES. The returned service always contains BearerAuth.

Auto Trait Implementations§

§

impl<H> !RefUnwindSafe for GrpcApi<H>

§

impl<H> !UnwindSafe for GrpcApi<H>

§

impl<H> Freeze for GrpcApi<H>

§

impl<H> Send for GrpcApi<H>
where H: Sync + Send,

§

impl<H> Sync for GrpcApi<H>
where H: Sync + Send,

§

impl<H> Unpin for GrpcApi<H>

§

impl<H> UnsafeUnpin for GrpcApi<H>

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

Source§

fn into_api<A>(self) -> UseApi<T, A>
where T: Sized,

into UseApi
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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