Skip to main content

Crate heddle_api

Crate heddle_api 

Source
Expand description

Generated transport-neutral Rust types for the Heddle API.

Modules§

framing
heddle
Heddle API protobuf packages.
signing
Contract-owned request-signing bytes and header vocabulary.

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§

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.
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.
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§

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.