oxiproto-wkt — Well-Known Types interop for OxiProto

oxiproto-wkt provides ergonomic, Pure-Rust interop for the Google protobuf Well-Known Types (the google.protobuf.* messages). It layers extension traits onto the WKT structs from prost-types — adding construction helpers, accessors, validation, set operations, ordering, and conversions to/from standard Rust time types — and supplies its own Pure-Rust equivalents for the WKTs that prost-types does not export (the scalar wrappers and Empty). It is the WKT layer of the OxiProto stack and is re-exported from the oxiproto facade behind the wkt feature.

All standard WKT types are re-exported from this crate, so callers typically depend on oxiproto-wkt alone. The crate is #![forbid(unsafe_code)]; the default code paths use a hand-rolled, dependency-free calendar/RFC-3339 implementation, so no chrono/time dependency is pulled in unless you opt into the corresponding feature.

Installation

[dependencies]
oxiproto-wkt = "0.1.3"

# Optional: chrono interop
# oxiproto-wkt = { version = "0.1.3", features = ["chrono"] }

# Optional: time interop
# oxiproto-wkt = { version = "0.1.3", features = ["time"] }

Or, via the facade (use wkt-chrono for the chrono methods):

[dependencies]
oxiproto = { version = "0.1.3", features = ["wkt"] }

Quick Start

use oxiproto_wkt::{Timestamp, TimestampExt, Duration, DurationExt};

// Current wall-clock time as a Timestamp, formatted RFC 3339.
let now = Timestamp::now();
let s = now.to_rfc3339()?;
let parsed = Timestamp::from_rfc3339(&s)?;

// Duration arithmetic and canonical string form.
let d = Duration::from_duration_string("1.5s")?;
let later = now.add_duration(&d)?;
assert_eq!(Duration { seconds: 1, nanos: 500_000_000 }.to_duration_string(), "1.5s");
# Ok::<(), oxiproto_wkt::OverflowError>(())

Packing into Any

use oxiproto_wkt::{Any, AnyExt, Timestamp, TimestampExt};

let ts = Timestamp::now();
let any = Any::pack(&ts);                 // type.googleapis.com/google.protobuf.Timestamp
assert!(any.is::<Timestamp>());
let back: Option<Timestamp> = any.unpack();

Well-Known Types covered

Re-exported from prost_types at the crate root: Any, Duration, FieldMask, ListValue, SourceContext, Struct, Timestamp, Value. The scalar wrappers and Empty are defined natively in this crate because prost-types does not export them.

API Overview

TimestampExt — extension trait for Timestamp

Free function: timestamp_cmp(a, b) -> Ordering (lexicographic by (seconds, nanos); prost-types does not derive Ord for Timestamp).

DurationExt — extension trait for Duration

Free function: duration_cmp(a, b) -> Ordering (lexicographic by (seconds, nanos) on canonical durations).

AnyExt — extension trait for Any

FieldMaskExt — extension trait for FieldMask

StructExt / ValueExt / ListValueExt — google.protobuf.Struct family

ValueExt (for Value):

StructExt (for Struct): empty(), insert(key, value), get(key) -> Option<&Value>, len(), is_empty().

ListValueExt (for ListValue): from_vec(Vec<Value>), iter(), len(), is_empty(), get(index) -> Option<&Value>.

Reflection/descriptor WKTs — ApiExt, TypeExt, EnumTypeExt, SourceContextExt

Scalar wrapper types & WrapperExt

Native structs DoubleValue, FloatValue, Int64Value, UInt64Value, Int32Value, UInt32Value, BoolValue, StringValue, BytesValue — each a single-field value struct deriving Debug/Clone/PartialEq/Default (and Copy/Eq where applicable). Each implements WrapperExt<T>:

Empty

A zero-field message equivalent to google.protobuf.Empty (which prost-types does not export). Provides the Empty struct, the EMPTY const, and EmptyExt::new().

OverflowError

The crate's error type, returned by the fallible conversion/arithmetic methods. Carries an operation name and a human-readable detail. Implements Debug/Clone/PartialEq/Eq, Display, and std::error::Error, and converts to/from oxiproto_core::OxiProtoError.

Feature Flags

Both are off by default, keeping the default build dependency-free (Pure Rust, hand-rolled calendar math).

Cross-references

License

Apache-2.0 — COOLJAPAN OU (Team Kitasan)