mirror of
https://github.com/zap-proto/rust.git
synced 2026-10-30 15:04:23 +00:00
zeekay
ed429a2283
Cap'n Proto was the canonical name for this Rust implementation. The
ZAP rebrand had only been applied as a directory rename so far —
crate names, schema file extensions, import paths, and binaries all
still said `capnp` / `capnpc`. This commit makes the rebrand real.
Workspace renames:
- crate capnp/ → zap/ (name = "zap")
- crate capnpc/ → zapc/ (name = "zapc")
- crate capnp-futures/ → zap-futures/
- crate capnp-rpc/ → zap-rpc/
Source-file renames:
- *_capnp.rs → *_zap.rs (~12 files: schema_zap.rs, rpc_zap.rs, etc.)
- capnpc-rust.rs → zapc-rust.rs (the codegen binary entry point)
- *.capnp → *.zap (33 schema files)
Identifier renames across the workspace (96 files rewritten):
- `use capnp::` → `use zap::`
- `extern crate capnp` → `extern crate zap`
- `capnp::generated_code!` → `zap::generated_code!`
- `capnp::traits::Owned` → `zap::traits::Owned`
- `capnp::message::...` → `zap::message::...`
- `capnp::Error/Result` → `zap::Error/Result`
- `capnp::Word` → `zap::Word`
- `capnp::primitive_list` → `zap::primitive_list`
- `capnp::any_pointer` → `zap::any_pointer`
- (etc. — see python script in commit history for full list)
Cargo.toml dep keys:
- `capnp = { path = ... }` → `zap = { path = ... }`
- `[dependencies.capnp]` → `[dependencies.zap]`
- `capnpc = { ... }` → `zapc = { ... }`
- Per-crate name= field and bin = "capnpc-rust" → "zapc"
Schema header strip:
- `using Cxx = import "/capnp/c++.capnp";` lines removed (C++ binding
hints; Rust output doesn't need them, and they referenced a system
/usr/include path we don't ship)
- `$Cxx.namespace("capnp::...")` annotations removed
Build-time decoupling for the benchmark:
- Pre-generated `carsales_zap.rs`, `catrank_zap.rs`, `eval_zap.rs` are
now committed in benchmark/. benchmark/build.rs just copies them
into OUT_DIR instead of invoking the schema compiler at build time.
- benchmark/Cargo.toml drops the [build-dependencies] zapc entry.
Building the benchmark needs ONLY the `zap` runtime crate; no
schema-compiler binary, no plugin, no shell-out.
To regenerate the schema-bound .rs from .zap (developer-only step):
cargo build --release --bin zapc
ln -sf zapc target/release/capnpc-rust # plugin discovery name
cd benchmark && PATH=../target/release:$PATH \
capnp compile -orust eval.zap catrank.zap carsales.zap
The `capnp` tool here is the upstream C++ schema-text parser — only
used as a parser frontend at codegen time, never linked into the
benchmark binary. Runtime + build = 100% zap/zapc only.
Verified by:
cargo tree -p benchmark --release → no capnp dep
grep -rE 'capnp|Capnp|CAPNP' . → 0 hits in active source
cargo build -p benchmark --release → clean build, no system tool
bash ./benchmark/bench.sh quick → runs end-to-end
Other workspace members (fill_random_values, addressbook,
wasm-hello-world, capnpc/test fixtures) still use build.rs schema
compilation at build time; they require a `zap` binary in PATH.
That's pre-existing — the upstream Cap'n Proto Rust workspace had the
same requirement against the `capnp` binary. Out of scope for this PR.
50 lines
1.8 KiB
Plaintext
50 lines
1.8 KiB
Plaintext
# This file contains annotations that are recognized by the zapc-rust code generator.
|
|
#
|
|
# To use this file, you will need to make sure that it is included in the directories
|
|
# searched by `zap compile`. An easy way to do that is to copy it into your project
|
|
# alongside your own schema files.
|
|
|
|
@0x83b3c14c3c8dd083;
|
|
|
|
annotation name @0xc2fe4c6d100166d0 (field, struct, enum, enumerant, union, group) :Text;
|
|
# Rename something in the generated code. The value that you specify in this
|
|
# annotation should follow zap capitalization conventions. So, for example,
|
|
# a struct should use CamelCase capitalization like `StructFoo`, even though
|
|
# that will get translated to a `struct_foo` module in the generated Rust code.
|
|
#
|
|
# TODO: support annotating more kinds of things with this.
|
|
|
|
annotation parentModule @0xabee386cd1450364 (file) :Text;
|
|
# A Rust module path indicating where the generated code will be included.
|
|
# For example, if this is set to "foo::bar" and the schema file is named
|
|
# "baz.zap", then you could include the generated code like this:
|
|
#
|
|
# pub mod foo {
|
|
# pub mod bar {
|
|
# zap::generated_code!(pub mod baz_zap);
|
|
# }
|
|
# }
|
|
|
|
annotation option @0xabfef22c4ee1964e (field) :Void;
|
|
# Make the generated getters return Option<T> instead of T. Supported on
|
|
# pointer types (e.g. structs, lists, and blobs).
|
|
#
|
|
# Zap pointer types are nullable. Normally get_field will return the default
|
|
# value if the field isn't set. With this annotation you get Some(...) when
|
|
# the field is set and None when it isn't.
|
|
#
|
|
# Given
|
|
#
|
|
# struct Test {
|
|
# field @0 :Text $Rust.option;
|
|
# }
|
|
#
|
|
# you get getters like so
|
|
#
|
|
# assert_eq!(struct_with.get_field(), Some("foo"));
|
|
# assert_eq!(struct_without.get_field(), None));
|
|
#
|
|
# The setters are unchanged to match the Rust convention.
|
|
#
|
|
# Note: Support for this annotation on interfaces isn't implemented yet.
|