Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/capnproto/capnproto-rust
Cap'n Proto for Rust
https://github.com/capnproto/capnproto-rust
Last synced: 2 days ago
JSON representation
Cap'n Proto for Rust
- Host: GitHub
- URL: https://github.com/capnproto/capnproto-rust
- Owner: capnproto
- License: mit
- Created: 2013-07-04T15:16:00.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-03-29T15:05:51.000Z (10 months ago)
- Last Synced: 2024-04-14T15:24:10.893Z (9 months ago)
- Language: Rust
- Size: 7.33 MB
- Stars: 1,937
- Watchers: 38
- Forks: 212
- Open Issues: 79
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rust-cn - capnproto/capnproto-rust - ci.org/capnproto/capnproto-rust.svg?branch=master">](https://travis-ci.org/capnproto/capnproto-rust) (Libraries / Encoding)
- awesome-rust - capnproto/capnproto-rust - ci.org/capnproto/capnproto-rust.svg?branch=master">](https://travis-ci.org/capnproto/capnproto-rust) (Libraries / Encoding)
- awesome-rust - capnproto/capnproto-rust
- awesome-rust-cn - capnproto/capnproto-rust
- awesome-rust-zh - capnproto/capnproto-rust - [<img src="https://api.travis-ci.org/capnproto/capnproto-rust.svg?branch=master">](https://travis-ci.org/capnproto/capnproto-rust) (库 / 编码(Encoding))
- awesome-rust - capnproto/capnproto-rust - Cap'n Proto is a type system for distributed systems (Libraries / Encoding)
- awesome-rust - capnproto/capnproto-rust - ci.org/capnproto/capnproto-rust.svg?branch=master">](https://travis-ci.org/capnproto/capnproto-rust) (库 Libraries / 加密 Encoding)
- fucking-awesome-rust - capnproto/capnproto-rust - Cap'n Proto is a type system for distributed systems (Libraries / Encoding)
- fucking-awesome-rust - capnproto/capnproto-rust - Cap'n Proto is a type system for distributed systems (Libraries / Encoding)
README
# Cap'n Proto for Rust
[](https://github.com/capnproto/capnproto-rust/actions?query=workflow%3ACI)
[documentation](https://docs.rs/capnp/)
For the latest news,
see the [capnproto-rust blog](https://dwrensha.github.io/capnproto-rust).
## Introduction
[Cap'n Proto](https://capnproto.org) is a type system for distributed systems.
With Cap'n Proto, you describe your data and interfaces
in a [schema file](https://capnproto.org/language.html), like this:
```capnp
@0x986b3393db1396c9;
struct Point {
x @0 :Float32;
y @1 :Float32;
}
interface PointTracker {
addPoint @0 (p :Point) -> (totalPoints :UInt64);
}
```
You can then use the [capnp tool](https://capnproto.org/capnp-tool.html#compiling-schemas)
to generate code in a [variety of programming languages](https://capnproto.org/otherlang.html).
The generated code lets you produce and consume values of the
types you've defined in your schema.
Values are encoded in [a format](https://capnproto.org/encoding.html) that
is suitable not only for transmission over a network and persistence to disk,
but also for zero-copy in-memory traversal.
That is, you can completely skip serialization and deserialization!
It's in this sense that Cap'n Proto is
["infinity times faster"](https://capnproto.org/news/2013-04-01-announcing-capn-proto.html)
than alternatives like Protocol Buffers.
In Rust, the generated code for the example above includes
a `point::Reader<'a>` struct with `get_x()` and `get_y()` methods,
and a `point::Builder<'a>` struct with `set_x()` and `set_y()` methods.
The lifetime parameter `'a` is a formal reminder
that `point::Reader<'a>` and `point::Builder<'a>`
contain borrowed references to the raw buffers that contain the encoded messages.
Those underlying buffers are never actually copied into separate data structures.
The generated code for the example above also includes
a `point_tracker::Server` trait with an `add_point()` method,
and a `point_tracker::Client` struct with an `add_point_request()` method.
The former can be implemented to create a network-accessible object,
and the latter can be used to invoke a possibly-remote instance of a `PointTracker`.
## Features
- [tagged unions](https://capnproto.org/language.html#unions)
- [generics](https://capnproto.org/language.html#generic-types)
- [protocol evolvability](https://capnproto.org/language.html#evolving-your-protocol)
- [canonicalization](https://capnproto.org/encoding.html#canonicalization)
- [`Result`-based error handling](https://dwrensha.github.io/capnproto-rust/2015/03/21/error-handling-revisited.html)
- [`no_std` support](https://dwrensha.github.io/capnproto-rust/2020/06/06/no-std-support.html)
- [no-alloc support](https://dwrensha.github.io/capnproto-rust/2023/09/04/0.18-release.html)
- [reflection](https://dwrensha.github.io/capnproto-rust/2023/05/08/run-time-reflection.html)
## Crates
| | | |
| ----- | ---- | ---- |
| [capnp](/capnp) | Runtime library for dealing with Cap'n Proto messages. | [](https://crates.io/crates/capnp) |
| [capnpc](/capnpc) | Rust code generator [plugin](https://capnproto.org/otherlang.html#how-to-write-compiler-plugins), including support for hooking into a `build.rs` file in a `cargo` build. | [](https://crates.io/crates/capnpc) |
| [capnp-futures](/capnp-futures) | Support for asynchronous reading and writing of Cap'n Proto messages. | [](https://crates.io/crates/capnp-futures) |
| [capnp-rpc](/capnp-rpc) | Object-capability remote procedure call system with ["level 1"](https://capnproto.org/rpc.html#protocol-features) features. | [](https://crates.io/crates/capnp-rpc) |
## Examples
[addressbook serialization](/example/addressbook),
[RPC](/capnp-rpc/examples)
## Who is using capnproto-rust?
- Sandstorm's [raw API example app](https://github.com/dwrensha/sandstorm-rawapi-example-rust) and
[collections app](https://github.com/sandstorm-io/collections-app)
- [juice](https://github.com/spearow/juice)
- [fractalide](https://github.com/fractalide/fractalide)
- [combustion-engine](https://github.com/combustion-engine/combustion/tree/master/combustion_protocols)
## Unimplemented / Future Work
- [orphans](https://capnproto.org/cxx.html#orphans)