Expand description
API to interact with a local blob store
This API is for local interactions with the blob store, such as importing and exporting blobs, observing the bitfield of a blob, and deleting blobs.
The main entry point is the Blobs struct.
Structs§
- AddBytes
Options - Options for adding bytes.
- AddPath
Options - Options for adding data from a file system path.
- AddProgress
- A progress handle for an import operation.
- Batch
- A batch of operations that modify the blob store.
- Batch
AddProgress - A progress handle for a batch scoped add operation.
- Bitfield
- The state of a bitfield, or an update to a bitfield
- Blobs
- Blobs API
- Blobs
List Progress - A progress handle for a blobs list operation.
- Delete
Options - Options for force deletion of blobs.
- Export
BaoOptions - Export the given ranges in bao format, with the iroh block size.
- Export
BaoProgress - A progress handle for a bao export operation.
- Export
Options - Export a file to a target path.
- Export
Progress - A progress handle for an export operation.
- Export
Ranges Options - Export the given ranges as chunkks, without validation.
- Export
Ranges Progress - A progress handle for a bao export operation.
- Import
BaoHandle - A handle for an ongoing bao import operation.
- Import
BaoOptions - Import bao encoded data for the given hash with the iroh block size.
- Observe
Options - Observe the local bitfield of the given hash.
- Observe
Progress - An observe result. Awaiting this will return the current state.
Enums§
- AddProgress
Item - Progress events for importing from any local source.
- Blob
Status - Status information about a blob.
- Encoded
Item - A content item for the bao streaming protocol.
- Export
Mode - The import mode describes how files will be imported.
- Export
Progress Item - Progress events for exporting to a local file.
- Import
Mode - The import mode describes how files will be imported.