Skip to main content

GrpcServerBuilder

rskit_server::builder

Struct GrpcServerBuilder

pub struct GrpcServerBuilder { /* private fields */ }

Expand description

Builder for a GrpcServer component.

§gRPC Reflection

Enable server reflection so tools like grpcurl can discover services:

// In your build.rs, configure tonic_build to output a file descriptor set:
//   tonic_build::configure()
//       .file_descriptor_set_path("src/descriptor.bin")
//       .compile(&["proto/my_service.proto"], &["proto/"])?;

let descriptor = include_bytes!("descriptor.bin");

let server = GrpcServerBuilder::new(GrpcServerConfig::default())
    .with_reflection(descriptor)
    .build();

Then query with grpcurl:

grpcurl -plaintext localhost:50051 list
grpcurl -plaintext localhost:50051 describe my.package.MyService

Implementations§

impl GrpcServerBuilder

pub fn new(config: GrpcServerConfig) -> Self

Create a new builder with the given server configuration.

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

Override the component name (default: "grpc-server").

pub fn with_reflection(self, file_descriptor_set: &[u8]) -> Self

Enable gRPC server reflection for service discovery.

Accepts the compiled FileDescriptorSet bytes produced by tonic-build. Configure tonic-build in your build.rs:

tonic_build::configure()
    .file_descriptor_set_path("src/descriptor.bin")
    .compile(&["proto/service.proto"], &["proto/"])?;

Then pass the bytes to the builder:

builder.with_reflection(include_bytes!("descriptor.bin"))

pub fn add_service<S>(self, svc: S) -> Self
where S: Service<Request<Body>, Response = Response<Body>, Error = Infallible> + NamedService + Clone + Send + Sync + 'static, S::Future: Send + 'static,

Add a tonic-generated service.

The service is automatically wrapped with ErrorLayer so that all gRPC error responses carry structured JSON details. If with_reflection was called, the reflection service is automatically added alongside each user service.

pub fn build(self) -> GrpcServer

Build the GrpcServer component.

Only the last registered service is used for the actual server (since tonic::transport::Router can’t be accumulated type-safely without the concrete service type). For multiple services, compose them before calling add_service, or use the raw tonic API.

Auto Trait Implementations§

impl !RefUnwindSafe for GrpcServerBuilder

impl !UnwindSafe for GrpcServerBuilder

impl Freeze for GrpcServerBuilder

impl Send for GrpcServerBuilder

impl Sync for GrpcServerBuilder

impl Unpin for GrpcServerBuilder

impl UnsafeUnpin for GrpcServerBuilder

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<L> LayerExt<L> for L

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.

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more