Expand description
The v0 HTTP protocol shapes.
Every v0 request and response type is available from this module. Common types are also re-exported from the crate root. The submodules group types by API area:
operations— namespace lifecycle, path-oriented filesystem operations, file revisions, maintenance, and theApiErrorbody.reads— authoritative read results (stat/list entries, file bytes).commits— commit results and the change feed.search— content search and grep-index administration.uploads— upload sessions and direct-put access.downloads— direct-get download grants.
Structs§
- Advance
Retention Request - Selects retention-floor advancement. This request has no options yet.
- Advance
Retention Response - Result of advancing the retention floor.
- ApiError
- HTTP error body used by LoonFS APIs.
- Attributes
Projection - Attributes returned for one inode.
- Begin
Download ByInode Request - Empty request for an inode-addressed download.
- Begin
Download ByInode Response - A short-lived capability to read one inode revision.
- Begin
Download Request - What a client names when it asks to read a file directly.
- Begin
Download Response - A short-lived capability to read one file’s content object, plus everything the reader needs to check what arrives.
- Checkpoint
- One checkpoint resource, reported from what its durable record carries.
- Commit
Request - A request to commit one or more filesystem operations.
- Commit
Response - Result of one commit.
- Committed
Change - One committed change in namespace order.
- Complete
Multipart Upload Request - Information required to complete a
direct_multipartupload. - Completed
Upload Part - One uploaded part, as the client observed the provider accept it.
- Content
Token - Proof that a specific
content_refmay be used in a later commit. - Create
Checkpoint Request - Request to create a durable checkpoint pin.
- Create
Namespace Request - Request to create a namespace.
- Create
Snapshot Request - Request to create a snapshot.
- Delete
Namespace Response - Result of deleting a namespace.
- Deleted
Object Counts - Objects deleted by one GC pass, grouped by object family. Every field is present, including zero counts.
- Directory
Binding - A directory entry’s parent and name.
- Error
Details - Optional machine-readable details for an
ApiError. - Extend
Snapshot Request - Request to extend a read snapshot.
- File
Bytes - File bytes plus the metadata entry they came from.
- File
Revision - One immutable file revision.
- Flush
WalResponse - Result of one WAL flush: what the metadata root references afterward.
- Fork
Namespace Request - Request to fork a namespace.
- GcRequest
- Optional overrides for one garbage-collection pass. Absent fields use the server’s conservative defaults.
- GcResponse
- Result of one mark-and-sweep garbage-collection pass.
- Grep
GcRequest - One explicit grep-index garbage-collection pass (admin plane).
- Grep
GcResponse - Result of one explicit grep-index garbage-collection pass (admin plane).
- Grep
Index - The namespace’s grep-index lifecycle and its cheap bookkeeping (admin plane).
- Grep
Match - One line-oriented match.
- Grep
Request - One content-search request.
- Grep
Response - One content-search page.
- List
Changes Response - Change-feed response after a cursor.
- List
Checkpoints Response - One page of active checkpoint records.
- List
File Revisions Response - Response for listing file revisions.
- List
Inode Children Response - One directory listing addressed by parent inode, and the namespace head it was answered at.
- List
Path Entries Response - One directory listing and the namespace head it was answered at.
- List
Snapshots Response - One page of live read snapshots.
- List
Trash Response - One trash listing page: the namespace’s recoverable deletions.
- Maintenance
Step Request - One explicit maintenance step: the actions it selects, and nothing more.
- Maintenance
Step Response - Result of one explicit maintenance step.
- Metadata
Maintenance Request - Overrides for the metadata-upkeep action.
- Metadata
Maintenance Response - What one metadata-upkeep action did, part by part.
- Namespace
- Current state for one namespace.
- Namespace
Diagnostics - Namespace state and storage details used by maintenance.
- Path
Entry - Metadata for one path returned by stat and directory-listing operations.
- Release
Checkpoint Response - Result of releasing a checkpoint pin.
- Release
Snapshot Response - Result of releasing a read snapshot.
- Released
Checkpoint Counts - Checkpoint records released by one GC pass, grouped by reason.
- Retained
Candidates - Candidates inspected but not deleted by one GC pass.
- Sign
Upload Parts Request - Request for part-upload capabilities on an open multipart session.
- Sign
Upload Parts Response - Response carrying one capability per requested part.
- Signed
Upload Part - One authorized part upload.
- Snapshot
Summary - A live snapshot.
- Store
Probe Check Result - One named contract check and what the store did with it.
- Store
Probe Request - Options for one store contract probe. Empty today; a body is still sent so later options do not change the shape of the request. An option this build does not know is rejected rather than ignored, so a caller never believes it selected something.
- Store
Probe Response - What one store contract probe observed, check by check.
- Trash
Entry - One deletion that can still be restored.
- Upload
Content Claim - Size and checksum reported by the client for a complete payload.
- Upload
Content Response - Response after uploading bytes into a session.
- Upload
Part Checksum Claim - One part’s checksum, supplied by the client so the server can sign it into that part’s upload URL.
- Upload
Session - Current view of one upload session.
Enums§
- Begin
Upload Request - Request to start an upload session, tagged by transport mode.
- Begin
Upload Response - Response to starting an upload session, tagged by transport mode.
- Checkpoint
Owner Summary - The owner of a checkpoint record.
- Complete
Upload Request - Request to complete an upload session.
- Delete
Directory Behavior - Directory delete behavior for path-oriented deletes.
- Destination
Behavior - Destination-conflict behavior for path-oriented puts, moves, and copies.
- Filesystem
Change - One semantic filesystem change inside a commit.
- Filesystem
Operation - One filesystem operation.
- Flush
WalOutcome - How one WAL flush satisfied its goal.
- Grep
Index Lifecycle - Where a namespace’s grep index is in its lifecycle.
- Object
Transfer Access - Client-facing direct transfer capability.
- Path
Entry Kind - Kind-specific metadata for a path entry.
- Reorganize
Step Outcome - What the metadata-reorganization part of a maintenance step did.
- Retained
Reason - The reason one candidate was retained, as the sweep site knows it. Each
variant is the field of
RetainedCandidatesit counts into, where the reason itself is described. - Store
Probe Check Outcome - What one contract check concluded about the store.
- Upload
Mode - Upload transport mode.
- Upload
Session Status - Observed state of an upload session.
- WalFlush
Step Outcome - What the WAL-flush part of a maintenance step did.