Expand description
§ppoppo-pcs-external-proto
Wire contract for the PCS External API. The .proto files are the SSOT and live
in this crate — the server and every client compile the same files, so the
contract cannot drift between them, and the crates.io tarball doubles as the
contract artifact for non-Rust codegen. The generated gRPC types are what you
depend on.
Package: pcs.external.v1, derived from the crate name (ppoppo-pcs-external-proto ⇔ pcs.external.v1 ⇔
proto/pcs/external/v1/).
[dependencies]
ppoppo-pcs-external-proto = "0.5"§You probably want the SDK instead
This crate is the raw contract: messages and client stubs, no transport policy,
no auth, no retry. Depend on ppoppo-pcs-external
— it wraps this crate with the OAuth2 client_credentials bearer flow, per-app rate-limit handling, and 401 re-auth.
Reach for this crate directly only when you are implementing the server side of the contract, or building tooling that speaks the wire format without the SDK’s policy.
§Services
| Service | Surface |
|---|---|
MessageService (messages.proto) | bulk send to ppnum recipients, status, the delivery stream, consent |
ChannelService (channels.proto) | channels, members, messages, the inbound stream |
TemplateService (templates.proto) | message templates |
AppService (apps.proto) | usage, polls, audit log |
§Features
default = []— message structs, codecs, and the generated client stubs, generic over any tonic service (noconnecthelpers, no server stubs). This is what the SDK and other clients build against.server— adds the server stubs and tonic’s transport layer. PCS (chat-api) enables it.
§Versioning
Semver on its own, independent of every other ppoppo crate. A breaking change to
the package is a new package, hence a new -v<N>-proto crate; a major of this
crate can come only from the codegen substrate (the tonic / prost pins).
§License
MIT OR Apache-2.0
Modules§
- pcs
- Module nesting mirrors the proto package (
pcs.external.v1). - ppoppo
- The chat vocabulary wire (
ppoppo.chat.v1) this face’s trigger messages carry, nested as its package is: a trigger’sFireSpec,CivilDateTimeandTriggerStateareppoppo::chat::v1::….
Structs§
- Timestamp
- Timestamp re-export so consumers don’t need a separate
prost-typespin. A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.
Constants§
- FILE_
DESCRIPTOR_ SET FileDescriptorSetbytes forpcs.external.v1, emitted bybuild.rs. Consumed by descriptor-driven drift canaries (chat-api’s scope-map drift, ppoppo-chat-realtime-proto’s schema inventory).