Expand description
The RepeStruct surface of repe, on its own.
A served struct’s endpoints are declared where the type is declared, and
that is not always the crate that runs the RPC. A pure-logic crate — no I/O,
no unsafe, buildable on any host, and often kept that way deliberately —
should not have to acquire a server, a client, and a transport just to
publish a couple of paths. Its choices without this crate were to derive
nothing and concede the sub-paths, or to take the whole dependency.
So this carries what a type needs to be served and nothing that serves it:
RepeStruct, the dispatch trait, andRepeMethods, the method table#[repe::methods]generates beside it;RequestBodyandResponseBody, what a write decodes from and a read encodes into;Servableand its halves, what a type must satisfy to cross a frame;StructError, what a handler reports;constants, the protocol enums those name.
repe re-exports every one of them at the same paths, so a type derived
against this crate mounts on a repe::Router with nothing in between, and
#[derive(RepeStruct)] resolves its generated paths against whichever of the
two crates it finds.
§Encoding
Bodies are read and written by structio, which carries JSON and BEVE in
one crate with no dependencies of its own and no intermediate Value. A
request is parsed straight into the live field it is destined for and a
response is written straight into the outgoing frame, so a read costs one
pass rather than three.
There are no features. The typed feature this crate used to carry existed
only because the BEVE encoder arrived with beve and six transitive packages
behind it, and a crate that merely declares a served type should not link
one to say so. That cost is gone, so
ResponseBody::write_typed_slice
is always there.
A served field’s own type is declared with structio’s macros rather than with
a derive; #[derive(RepeStruct)] publishes the endpoints, and structio
describes the encoding.
use repe_core::RepeStruct;
#[derive(Default, RepeStruct)]
struct Build {
version: String,
revision: u64,
}
structio::object!(Build { version, revision });Re-exports§
pub use constants::BodyFormat;pub use constants::ErrorCode;pub use constants::HEADER_SIZE;pub use constants::QueryFormat;pub use constants::REPE_SPEC;pub use constants::REPE_VERSION;pub use structs::MethodArgs;pub use structs::RepeStruct;pub use structs::RequestBody;pub use structs::ResponseBody;pub use structs::Servable;pub use structs::ServableRead;pub use structs::ServableWrite;pub use structs::StructError;
Modules§
Attribute Macros§
- methods
- Attribute macro that publishes every method of an inherent
implblock, generating thestructs::RepeMethodstable from the signatures themselves.
Derive Macros§
- Repe
Struct - Derive macro generating a
structs::RepeStructimplementation from a struct’s fields.