Attribute Macro proto_service 

#[proto_service]

Implements ProtoService for the given enum.

Since the enum is only meant to be used for schema purposes, the macro will erase all the fields in it and change its type to emit a unit struct, so as to not trigger false positives for “unused” variants.

Each variant represents a protobuf method for the given service, and it must contain two named fields, request and response, with the target message for each.

The target of a method must implement MessagePath, which is automatically implemented by the proto_message macro and for all types from the proto_types crate.

Attributes

These two attributes can be used on the container, to refer to the service as a whole, or to the individual methods.

• options

  • Type: Expr
  • Example: #[proto(options = vec![ my_option_1() ])]
  • Description: Specifies the options for the given service or method. It must resolve to an implementor of IntoIterator<Item = ProtoOption>.

• deprecated

  • Type: Ident
  • Example: #[proto(deprecated = true)] or #[deprecated]
  • Description: Marks the service or method as deprecated.

Furthermore, you can use the #[stream] attribute on the request/response fields to mark a request or response as a stream, as shown below.

Example

use indoc::indoc;
use protify::*;

proto_package!(MY_PKG, name = "my_pkg");

// A file must be in scope to be picked up by the service schema
define_proto_file!(MY_FILE, name = "my_file.proto", package = MY_PKG);

#[proto_message]
pub struct User {
	pub id: i32,
	pub name: String,
}

#[proto_message]
pub struct UserId {
	pub id: i32,
}

#[proto_message]
pub struct Status {
	pub success: bool,
}

#[proto_service]
enum UserService {
	GetUser {
        request: UserId,
        response: User
    },
	UpdateUser {
        #[stream]
        request: User,
        response: Status
    },
}

fn main() {
	let proto_rep = UserService::proto_schema();

	assert_eq!(
		proto_rep.render_schema().unwrap(),
		indoc! {"
            service UserService {
              rpc GetUser (UserId) returns (User);
              rpc UpdateUser (stream User) returns (Status);
            }"
		}
	);
}