Skip to main content

Module options

Module options 

Source
Expand description

Upload / download options. Mirrors bee-go’s pkg/api/options.go.

Option fields use Option<bool> to distinguish “unset” from “explicitly false” — matching bee-go’s *bool semantics. None omits the header; Some(false) sends the literal string "false".

Structs§

CollectionUploadOptions
Collection upload options for tar POST /bzz. Mirrors bee-go CollectionUploadOptions and bee-js streamDirectory opts.
DownloadOptions
Download options. All fields are optional; Default::default() keeps Bee defaults. Mirrors bee-go DownloadOptions.
FileUploadOptions
File-specific upload options for POST /bzz. Mirrors bee-go FileUploadOptions.
PostageBatchOptions
Postage stamp creation options. Mirrors bee-js / bee-go PostageBatchOptions.
RedundantUploadOptions
UploadOptions plus a redundancy level. Mirrors bee-go RedundantUploadOptions.
UploadOptions
Base set of options accepted by every upload endpoint. Mirrors bee-js / bee-go UploadOptions.
UploadProgress
Per-entry signal emitted by upload_collection / upload_collection_entries when an UploadProgress callback is configured. Mirrors bee-js streamDirectory onUploadProgress.

Enums§

RedundancyLevel
Data redundancy level applied at upload time. Mirrors bee-js RedundancyLevel.
RedundancyStrategy
Chunk-prefetch policy used when downloading erasure-coded data. Mirrors bee-js RedundancyStrategy.

Functions§

prepare_collection_upload_headers
Build the header set for a tar POST /bzz collection upload.
prepare_download_headers
Build the header set for a download. Setting any of act_publisher / act_history_address / act_timestamp implicitly turns Swarm-Act on.
prepare_file_upload_headers
Build the header set for a POST /bzz file upload.
prepare_redundant_upload_headers
Build the header set for a redundant upload.
prepare_upload_headers
Build the header set for a base upload. The batch is required.

Type Aliases§

HeaderPairs
Header pairs: name + value. Used to push headers into a request builder in the order they were added.
OnEntryFn
Boxed callback invoked once per entry when uploading a collection.