Struct tonic_build::manual::MethodBuilder

pub struct MethodBuilder { /* private fields */ }

Method builder.

This builder can be used to manually define gRPC method, which can be added to a gRPC service, in rust code without the use of a .proto file.

Example

let say_hello_method = Method::builder()
    .name("say_hello")
    .route_name("SayHello")
    // Provide the path to the Request type
    .input_type("crate::common::HelloRequest")
    // Provide the path to the Response type
    .output_type("crate::common::HelloResponse")
    // Provide the path to the Codec to use
    .codec_path("crate::common::JsonCodec")
    .build();

Implementations

impl MethodBuilder

pub fn name(self, name: impl AsRef<str>) -> Self

Set the name for this Method.

This value will be used for generating the client functions for calling this Method.

Generally this is formatted in snake_case.

pub fn route_name(self, route_name: impl AsRef<str>) -> Self

Set the route_name for this Method.

This value will be used as part of the route for calling this method. Routes have the form: /<package_name>.<service_name>/<method_route_name>

Generally this is formatted in PascalCase.

pub fn comment(self, comment: impl AsRef<str>) -> Self

Add a comment string that should be included as a doc comment for this Method.

pub fn input_type(self, input_type: impl AsRef<str>) -> Self

Set the path to the Rust type that should be use for the Request type of this method.

pub fn output_type(self, output_type: impl AsRef<str>) -> Self

Set the path to the Rust type that should be use for the Response type of this method.

pub fn codec_path(self, codec_path: impl AsRef<str>) -> Self

Set the path to the Rust type that should be used as the Codec for this method.

Currently the codegen assumes that this type implements Default.

pub fn client_streaming(self) -> Self

Sets if the Method request from the client is streamed.

pub fn server_streaming(self) -> Self

Sets if the Method response from the server is streamed.

pub fn build(self) -> Method

Build a Method

Panics if name, route_name, input_type, output_type, or codec_path weren’t set.

Trait Implementations

impl Debug for MethodBuilder

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

Formats the value using the given formatter.

impl Default for MethodBuilder

fn default() -> MethodBuilder

Returns the “default value” for a type.