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§
- Collection
Upload Options - Collection upload options for tar
POST /bzz. Mirrors bee-goCollectionUploadOptionsand bee-jsstreamDirectoryopts. - Download
Options - Download options. All fields are optional;
Default::default()keeps Bee defaults. Mirrors bee-goDownloadOptions. - File
Upload Options - File-specific upload options for
POST /bzz. Mirrors bee-goFileUploadOptions. - Postage
Batch Options - Postage stamp creation options. Mirrors bee-js / bee-go
PostageBatchOptions. - Redundant
Upload Options UploadOptionsplus a redundancy level. Mirrors bee-goRedundantUploadOptions.- Upload
Options - Base set of options accepted by every upload endpoint. Mirrors
bee-js / bee-go
UploadOptions. - Upload
Progress - Per-entry signal emitted by
upload_collection/upload_collection_entrieswhen anUploadProgresscallback is configured. Mirrors bee-jsstreamDirectoryonUploadProgress.
Enums§
- Redundancy
Level - Data redundancy level applied at upload time. Mirrors bee-js
RedundancyLevel. - Redundancy
Strategy - 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 /bzzcollection upload. - prepare_
download_ headers - Build the header set for a download. Setting any of
act_publisher/act_history_address/act_timestampimplicitly turnsSwarm-Acton. - prepare_
file_ upload_ headers - Build the header set for a
POST /bzzfile 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.
- validate_
collection_ upload_ options - Validate that the user-controlled string fields of
CollectionUploadOptions(index_document,error_document) don’t contain CR / LF / NUL bytes. reqwest itself rejects these at request-build time, but the resulting error is a genericInvalidHeaderValuedeep in the I/O path; surfacing it early as [Error::Argument] is cleaner.
Type Aliases§
- Header
Pairs - Header pairs: name + value. Used to push headers into a request builder in the order they were added.
- OnEntry
Fn - Boxed callback invoked once per entry when uploading a collection.