Skip to main content

Crate hatchet_proto

Crate hatchet_proto 

Source
Expand description

Generated prost/tonic code for the Hatchet gRPC API.

The code under src/gen/ is generated from the protos in api-contracts/ (copied unmodified from the official Hatchet repository) by cargo xtask codegen, and committed, so building this crate never needs protoc.

§Layout

Three Hatchet protos (dispatcher, events, workflows) declare no package, and workflows refers to v1 types by relative path. The v1 module is therefore nested inside root, and re-exported at the crate root for convenience:

gRPC serviceModule
/Dispatcher/…, /EventsService/…, /WorkflowService/…root
/v1.AdminService/…, /v1.V1Dispatcher/…v1

§Features

  • server: also compile the generated tonic server traits, which is useful for building a mock engine in tests.

Re-exports§

pub use root::v1;
pub use prost;
pub use prost_types;
pub use tonic;

Modules§

root
Messages and services from the protos that declare no package.

Constants§

HATCHET_VERSION
The Hatchet release whose protos this crate was generated from, as the git tag of the official repository — for example "v0.107.0".