Skip to main content

Crate heddle_api

Crate heddle_api 

Source
Expand description

Generated transport-neutral Rust types for the Heddle API.

Modules§

descriptor_trust
Canonical two-layer root-attested ephemeral endpoint-descriptor contract.
framing
heddle
Heddle API protobuf packages.
mint_root_association
Checked wire decoding for messages whose mint-root association is security sensitive. Protobuf oneofs otherwise decode duplicate alternatives last-wins.
passkey_mint_grant
Canonical account-free statement signed by a WebAuthn passkey when it delegates a temporary mint root.
password_owner
Bounds and canonical signing inputs for password-unlocked client owner keys. These checks do not turn a password proof into owner authorization.
provider_v2
Canonical native provider-plan consent and exact assembly commitments. Protobuf is a transport container; these bytes are the portable proof.
request_proof
Portable verification of the native CallContext request proof. Verification grants no resource authority and does not consume the nonce; the receiving host must durably reject replay before serving or writing.
signing
Contract-owned request-signing bytes and header vocabulary.
treadle
Canonical encoding for the signed treadle definition contract.
v2
Shared v2 client behavior. Transport adapters retain key and connection ownership.

Structs§

InvalidIdentifierLength
Errors returned while constructing fixed-width API identifiers.
MethodDescriptor
Generated transport-neutral method contract.
RequestMetadataError
Malformed protobuf while extracting transport-level request metadata.
RoutedCall
Transport-neutral information passed from an operation-stream decoder to a contract router before the request body is decoded.

Enums§

MethodRoute
Generated stable route identity for every declared contract method.
StreamingShape
Message cardinality on each side of a contract method.

Constants§

ACCOUNT_BILLING_LOCK_POLICY_ID
Stable policy identifier for the account billing lock.
ALL_METHODS
All declared contract methods, sorted by fully-qualified path.
DEFAULT_PAGE_SIZE
Page size used when callers omit or pass zero for a requested size.
GRANT_ENVELOPE_V2_FIXTURE_JSON
Cross-product canonical GrantEnvelope v2 payload and rejection fixtures.
HOSTED_ALPN_V1
Production ALPN for the first transport-neutral hosted-call protocol.
HOSTED_CALL_V1_FIXTURE_JSON
Cross-product hosted-call framing and typed-failure fixture.
MAX_PAGE_SIZE
Largest page the public API permits.
PROVIDER_ALPN_V1
Production ALPN for an opaque-ticket provider extent transfer.
STATE_ATTACHMENT_AUTHORIZATION_CONFORMANCE
Generated exhaustive authorization classification for every current state attachment kind.
TRANSPORT_BOOTSTRAP_V1_FIXTURE_JSON
Cross-product endpoint-descriptor and relay-admission signing fixture.
UNARY_SIGNING_V1_FIXTURE_JSON
Cross-product canonical unary-signing fixture.

Functions§

account_billing_lock_error_detail
Builds the single structured error detail used for an account billing-lock denial. Hosts attach this detail to a FAILED_PRECONDITION failure.
account_billing_lock_from_error_detail
Returns the typed lock from a policy denial, rejecting details with a different reason, policy identifier, or context arm.
decode_account_billing_lock_error_detail
Decodes a transported ErrorDetail and extracts its account billing lock. A valid non-billing detail returns Ok(None).
encode_account_billing_lock_error_detail
Encodes a complete account billing-lock ErrorDetail for transport.
human_verification_challenge
Extract a human-verification challenge from an ErrorDetail, if present.
human_verification_error_detail
Build an ErrorDetail carrying a human-verification challenge (policy-denied with an actionable challenge), for the ErrorDetail.human_verification arm.
method_descriptor
Looks up a declared method by its canonical fully-qualified path.
normalize_page_size
Applies the contract-owned default and upper bound to a requested page.
state_attachment_authorization_classification
Returns the generated fail-closed classification for a known attachment kind.