dfhack-proto

Crates.iodfhack-proto
lib.rsdfhack-proto
version0.9.0
sourcesrc
created_at2022-04-17 22:23:27.810534
updated_at2024-04-21 19:04:15.044557
descriptionGenerated code from the DFHack API
homepage
repositoryhttps://github.com/plule/dfhack-remote
max_upload_size
id569606
size1,892,558
Pierre Lulé (plule)

documentation

README

dfhack_proto

Crates.io docs.rs Crates.io

This subcomponent of dfhack_remote contains all the generated code for interacting with DFHack remote API.

It contains two main modules:

  • [messages] exposes the protobuf messages. This is the standard generated protobuf.
  • [stubs] exposes the plugins and their RPC. DFHack is not using gRPC and this is a custom implementation

Internally these two modules are created under the generated module.

The terminology is based on gRPC: The stubs expose the feature from the plugin. They are built from a channel implementing the data exchange.

The code is regenerated under the condition that the environment variable DFHACK_REGEN is set.

This crates generates all its code directly in a source subfolder. It would likely be cleaner to use the $OUT_DIR, or macro to do this job.

Commit count: 127

cargo fmt