Skip to main content

Module api

Module api 

Source
Expand description

Generic API surface: upload/download options, headers, rich return types, and the pin / tag / stewardship endpoint methods. Mirrors pkg/api in bee-go.

Re-exports§

pub use endpoints::ApiService;
pub use endpoints::EnvelopeResponse;
pub use endpoints::GranteeResponse;
pub use endpoints::Tag;
pub use options::CollectionUploadOptions;
pub use options::DownloadOptions;
pub use options::FileUploadOptions;
pub use options::HeaderPairs;
pub use options::OnEntryFn;
pub use options::PostageBatchOptions;
pub use options::RedundancyLevel;
pub use options::RedundancyStrategy;
pub use options::RedundantUploadOptions;
pub use options::UploadOptions;
pub use options::UploadProgress;
pub use options::prepare_collection_upload_headers;
pub use options::prepare_download_headers;
pub use options::prepare_file_upload_headers;
pub use options::prepare_redundant_upload_headers;
pub use options::prepare_upload_headers;
pub use result::FileHeaders;
pub use result::UploadResult;
pub use result::parse_content_disposition_filename;

Modules§

endpoints
Network endpoint methods on ApiService: pin, tag, stewardship. Mirrors bee-go’s pkg/api/{pin,tag,stewardship}.go.
options
Upload / download options. Mirrors bee-go’s pkg/api/options.go.
result
Rich return types for upload + download. Mirrors bee-go’s pkg/api/result.go.