Skip to main content

Crate ppoppo_pas_plims_proto

Crate ppoppo_pas_plims_proto 

Source
Expand description

§ppoppo-pas-plims-proto

Wire contract for the PAS PLIMS ops face. 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: pas.plims.v1, derived from the crate name (ppoppo-pas-plims-proto ⇔ pas.plims.v1 ⇔ proto/pas/plims/v1/).

Its messages carry the identity enums (EntityType, LifecycleState, Lifetime, Reach) of the vocab wire ppoppo-identity-proto (ppoppo.identity.v1), re-exported at this crate’s root, so a crate speaking this face names them through its one wire. A non-Rust client adds that crate’s proto/ directory to its include path.

[dependencies]
ppoppo-pas-plims-proto = "0.1"

§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-pas-plims — it wraps this crate with the OAuth2 client_credentials bearer flow, the scope family, and a configured channel.

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

ServiceSurface
NumberService (numbers.proto)sub-number creation, listing, lookup, and their capability declarations
AliasService (aliases.proto)alias records against a ppnum
MaskService (masks.proto)masked-number issuance
DependentService (dependents.proto)an AI agent creates a dependent agent it owns

§Features

  • default = [] — message structs, codecs, and the generated client stubs, generic over any tonic service (no connect helpers, no server stubs). This is what the SDK and other clients build against.
  • server — adds the server stubs and tonic’s transport layer. PAS (accounts-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§

pas
pas.plims.v1 package.

Structs§

Timestamp
Timestamp re-export so consumers don’t need a separate prost-types pin. 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.

Enums§

EntityType
The identity enums this face’s messages carry, from the ppoppo.identity.v1 vocabulary wire. What the principal IS — one question, one answer per principal.
LifecycleState
The identity enums this face’s messages carry, from the ppoppo.identity.v1 vocabulary wire. Where a number stands in its lifecycle. A number past its terminal state is not reported on any face.
Lifetime
The identity enums this face’s messages carry, from the ppoppo.identity.v1 vocabulary wire. How a number ends — one axis of its (lifetime, reach) cell, orthogonal to EntityType and fixed at mint.
Reach
The identity enums this face’s messages carry, from the ppoppo.identity.v1 vocabulary wire. Who may resolve and address a number — the other axis of its cell, fixed at mint.

Constants§

FILE_DESCRIPTOR_SET
FileDescriptorSet bytes for pas.plims.v1 (and the identity file it imports), emitted by build.rs. Consumed by descriptor-driven drift canaries.