Skip to main content

Crate mbx_cache_protocol

Crate mbx_cache_protocol 

Source
Expand description

Wire types and constants shared by mbx remote cache clients and servers.

These records are protocol-owned: changing their serialized shape or a framing constant is a wire-format change. Transport, authentication, local storage, and adapter behavior deliberately live outside this crate.

Structs§

ActionKindCapability
Schemas supported for one action adapter.
ActionPrediction
Adapter-owned data needed to reconstruct an action from a prior task run.
ActionPromiseCompletion
Immutable completion of an invocation-wide compilation promise.
ActionPromiseJoin
Request to join or claim one invocation-wide compilation promise.
ActionResult
A canonical action-result record referencing objects in the CAS.
Capabilities
Cache service capabilities negotiated before optional protocol features.
CapabilityFeatures
Optional server protocol features.
CapabilityLimits
Server-advertised request and object limits.
CapabilityProtocol
Version advertised by a cache service.
CcMetadata
C and C++ action metadata stored alongside compiled objects.
Digest
Algorithm-tagged digest and exact byte length of a cache object.
Directory
A canonical directory object stored in the CAS.
DirectoryNode
A child directory entry in a canonical cache directory.
FileNode
A file entry in a canonical cache directory.
ParseDigestAlgorithmError
A digest algorithm name was outside the version-one contract.
RustcMetadata
Rust-specific action metadata stored alongside compiled outputs.
SymlinkNode
A symbolic-link entry in a canonical cache directory.
TaskActionManifest
Predictions associated with one stable task identity.

Enums§

ActionPromiseState
State returned when a client joins an invocation-wide promise.
DigestAlgorithm
Hash algorithms supported by protocol version one.

Constants§

ACTION_PROMISE_MEDIA_TYPE
Media type for ephemeral, invocation-keyed compilation promises.
ACTION_RESULT_BATCH_MEDIA_TYPE
Media type for a JSON batch of ActionResult records.
ACTION_RESULT_MEDIA_TYPE
Media type for canonical ActionResult JSON records.
BLOB_MEDIA_TYPE
Media type for opaque content-addressed blobs.
BLOB_PACK_BLOBS_HEADER
Header declaring the number of blobs in a blob pack.
BLOB_PACK_BYTES_HEADER
Header declaring the total payload bytes in a blob pack.
BLOB_PACK_HEADER_BYTES
Bytes before each blob pack payload: algorithm, hash, and length.
BLOB_PACK_MAGIC
Magic prefix identifying a version-one blob pack.
BLOB_PACK_MEDIA_TYPE
Media type for framed batches of content-addressed blobs.
BLOB_PACK_RECEIPT_MEDIA_TYPE
Media type for the receipt describing an accepted blob-pack upload.
CLIENT_METADATA_MEDIA_TYPE
Media type for adapter-specific action metadata blobs.
DIGEST_LIST_MEDIA_TYPE
Media type for a JSON list of digests.
DIRECTORY_MEDIA_TYPE
Media type for canonical Directory JSON records.
MAX_ACTION_PREDICTION_PAYLOAD
Maximum serialized adapter payload in one action prediction.
MAX_ACTION_PROMISE_CLAIM_BYTES
Maximum opaque lease-token length accepted for an action promise.
MAX_BATCH_ITEMS
Maximum number of digests in a batch request supported by the protocol.
MAX_TASK_ACTION_PREDICTIONS
Maximum predictions carried by one task action manifest.
NAMESPACE_HEADER
Header carrying the caller’s isolated cache namespace.
PROTOCOL_HEADER
Header carrying the negotiated cache protocol version.
PROTOCOL_VERSION
Major version of the HTTP cache protocol.
TASK_ACTION_MANIFEST_MEDIA_TYPE
Media type for task-to-action prediction manifests.

Functions§

canonical_json
Serialize a protocol record using the JSON Canonicalization Scheme.