Schema

Use this reference to inspect fields, methods, accepted values and failure outcomes. For setup and working examples, start with the API guide.

Definition: abstraction.storage.lend

Service Lending [DEF-S1]

Storage lending implemented by a provider and mediated by the runtime. The provider listens on the shared identity-bound transport and admits designated runtime executables of its own account. A call whose peer identity could not be obtained fails with caller_unavailable; insufficient program proof fails with identity_required; another account or program reads not_permitted. The runtime decides the application caller's right before forwarding. Providers keep a ledger of their placements and preserve source files. Symbolic and hard links require no model-byte reads; an explicitly requested copy reads the source bytes.

Wire identity: abstraction.storage/lend@1

Handler error codes, declared by lending_error_codes: caller_unavailable, identity_required. Generated bindings name each as a ServiceErrorCode member beside the dispatcher's own codes.

Frames carry version, service, method and typed arguments. Transport owns framing, associated exchanges, deadlines and connections. Unknown version/service/method and malformed arguments are rejected before invoking a handler. One-way WriteFrame success means local submission, not remote acceptance or persistence.

Request-response methods use ExchangeFrame. Replies carry version, service, method, ok and payload; success payload contains typed value (or an empty object for void). Error payload contains nonempty code and message, which may be empty. ServiceError preserves unknown codes. Unexpected handler failures become handler_error without private details; invalid results become invalid_result. Clients validate reply identity and result before exposing it. A malformed frame or transport failure remains a local error; the transport must associate each response with its exchange. C++ dispatchers are pure protocol bindings, not listening servers.

Place the named object in the engine's own directory by link, so that engine serves it. store and object are the inventory's naming: object is a manifest id, the name the store gives that manifest, or an object locator, and never a path. engine is a declared host name this provider supports. copy true asks for a copy where a link cannot be made and is counted as a copy; false refuses with link_refused instead. Gated by abstraction.storage/lend on resource engine:<name>, admitted through the runtime's first-use question. An object this provider's stores do not hold is unknown_object; an engine it does not support, or one whose own configuration cannot be pointed at the lent directory without a person editing its configuration file, is unsupported_engine; a link neither the operating system nor the volume allows is link_refused; an object already lent to that engine is already_lent with the entry in force. The original is never moved, renamed or deleted.

Lend

request-response LendResult

• Argument 1: string store (required, including zero/false/empty)
• Argument 2: string object (required, including zero/false/empty)
• Argument 3: string engine (required, including zero/false/empty)
• Argument 4: bool copy (required, including zero/false/empty)

Remove exactly the link this entry created and the directories this provider made for it, and drop the entry. The source file is untouched. Gated by abstraction.storage/lend on the entry's own engine:<name>. The engine's own list may keep naming the model until that engine's idle-unload timer fires; the ledger is the answer to whether the lend is in force.

Unlend

request-response UnlendResult

• Argument 1: string entry (required, including zero/false/empty)

The ledger. limit is 1..256. Continuations are at most 256 bytes and name a retained page position; an unknown one is invalid.

Lends

request-response LendPage

• Argument 1: string continuation (required, including zero/false/empty)
• Argument 2: i64 limit (required, including zero/false/empty)

Encoding [DEF-E1]

Types

Named types [DEF-T2]

One spelling is written [DEF-G2] and a wider set is read [DEF-G1]; the width between them is the interoperability guarantee.

Structs [DEF-T1]

A field is required, or says when it is omitted [DEF-A4]. Each struct says on its own what it does with a field name it has never heard of [DEF-A7]. A wire name never moves; where a language must spell it differently the field says so [DEF-A2].

Lend

unknown fields refuse

LendResult

the document [DEF-A1] · unknown fields refuse

UnlendResult

unknown fields refuse

LendPage

unknown fields refuse

Enumerations [DEF-T5]

Enum fields carry JSON strings containing exact member wire spellings, never numeric IDs. Unknown names are preserved with grant and refused as bad_enum with refuse on read and write. Optional absent fields preserve presence separately from an empty string.

An enumeration is a closed vocabulary of wire names, and each one says on its own what a reader does with a member it has never heard of [DEF-A5].

Link

a member this reader does not know is refuse

LendOutcome

a member this reader does not know is refuse

UnlendOutcome

a member this reader does not know is refuse

LendsOutcome

a member this reader does not know is refuse

Constants [DEF-A6]

Refusal words [DEF-R1]