oxiproto — The COOLJAPAN Pure-Rust protobuf facade

oxiproto is the top-level facade crate for the OxiProto stack — a Pure-Rust protobuf toolkit that needs no protoc and no C/C++ libraries. It re-exports the core wire-format types from oxiproto-core (always available) and conditionally surfaces each higher layer — build-time codegen, runtime reflection, Well-Known Types, and canonical JSON — behind cargo features, so you depend on a single crate and turn on only what you use.

OxiProto ships its own native wire codec via the OxiMessage trait (no prost derive macros required) while remaining interoperable with prost's Message / Name traits, which are re-exported for compatibility. Code generation from .proto files happens at build time through oxiproto-build / oxiproto-codegen; the generated types can implement OxiMessage directly.

Installation

[dependencies]
# Core only (wire format + traits), always Pure Rust.
oxiproto = "0.1.2"

# Build-time .proto compilation (for build.rs).
oxiproto = { version = "0.1.2", features = ["build"] }

# Runtime reflection + canonical JSON.
oxiproto = { version = "0.1.2", features = ["reflect", "json"] }

# Well-Known Types with chrono interop.
oxiproto = { version = "0.1.2", features = ["wkt-chrono"] }

# Everything.
oxiproto = { version = "0.1.2", features = ["build", "reflect", "wkt-chrono", "codegen", "json"] }

Quick Start

use oxiproto::prelude::*;

// `OxiMessage` is the native wire-format encode/decode trait.
// Generated types implement it when codegen emits `emit_oxi_message_impl=true`,
// after which the crate-level helpers work directly:
fn roundtrip<T: OxiMessage + PartialEq + std::fmt::Debug>(msg: &T) {
    let bytes = oxiproto::encode(msg);
    let decoded = oxiproto::decode::<T>(&bytes).expect("decode");
    assert_eq!(&decoded, msg);
}

The native wire primitives are always available, regardless of features:

use oxiproto::wire::{DecodeBuffer, EncodeBuffer, WireType};

API Overview

Crate-root functions

Traits re-exported at the crate root

Other crate-root re-exports

prelude module

use oxiproto::prelude::*; glob-imports the most common types: OxiMessage, OxiName, OxiOneof, Extensions, Message, Name, OxiProtoError, OxiProtoResult, and the wire types DecodeBuffer, EncodeBuffer, WireType.

Feature-gated sub-modules

Each enabled feature surfaces the corresponding sub-crate under a module of the same name (a pub use <crate>::*; re-export):

Feature Flags

The default feature set is empty: a bare oxiproto dependency gives you the always-available core (wire format + traits) and nothing else.

OxiProtoError variants

The stack-wide error enum (#[non_exhaustive]). Implements Display and std::error::Error, with From conversions from std::io::Error and wire::WireError.

OxiProto crates

License

Apache-2.0 — COOLJAPAN OU (Team Kitasan)