storj 1.1.1

Native Rust Uplink client for the Storj decentralized object store
Documentation
//! Native Rust Uplink client for the Storj decentralized object store.
//!
//! **1.1.1** extends the public `storj::*` API: access grants, buckets,
//! objects (multi-segment upload/download), listing, copy/move, multipart,
//! revoke, and Object Lock. Edge credential registration and linksharing are
//! outside this crate's scope.
//!
//! Not a wrapper around `uplink-c`, and not a drop-in for crates.io `uplink`
//! 0.11.0 (blocking FFI, `!Send`). Spec: `docs/design-native-uplink.md`.
//!
//! Depend on this crate from crates.io (`storj = "1.1"`). Callers need their
//! own Tokio runtime (`tokio` is not re-exported).
//!
//! MSRV 1.88, edition 2024. Dual-licensed MIT OR Apache-2.0.
//!
//! # Walkthrough
//!
//! `commit()` publishes the object. Dropping [`Upload`] without `commit`
//! aborts. `poll_shutdown` does not commit.
//!
//! ```no_run
//! use storj::{Access, Project};
//! use tokio::io::AsyncWriteExt;
//!
//! # async fn run() -> storj::Result<()> {
//! let access = Access::parse(&std::env::args().nth(1).expect("grant"))?;
//! let project = Project::open(&access).await?;
//! project.ensure_bucket("logs").await?;
//!
//! let mut upload = project
//!     .upload_object("logs", "hello.txt", Default::default())
//!     .await?;
//! upload.write_all(b"hello storj").await?;
//! let _obj = upload.commit().await?;
//!
//! let mut download = project
//!     .download_object("logs", "hello.txt", Default::default())
//!     .await?;
//! let mut buf = Vec::new();
//! tokio::io::copy(&mut download, &mut buf).await?;
//! download.close().await?;
//! project.close().await?;
//! # Ok(())
//! # }
//! ```

#![deny(clippy::undocumented_unsafe_blocks)]

pub use events::{
    DiagnosticRange, Operation, Outcome, Telemetry, TelemetryEvent, TransferDiagnostics,
};
pub use network::{NetworkOptions, TransportKind, TransportMode};
mod events;
mod network;
mod telemetry;

pub mod access;
mod bucket;
pub mod config;
pub mod constants;
pub mod encryption;
pub mod error;
pub(crate) mod metainfo;
mod object_lock;
mod objects;
pub mod project;
pub mod types;
pub mod upload;

pub use access::{Access, Permission, SharePrefix};
pub use config::{Config, TlsIdentity};
pub use encryption::EncryptionKey;
pub use error::{Error, ErrorKind, Result};
pub use project::{BucketStream, ObjectStream, PartStream, Project, UploadStream};
pub use types::{
    Bucket, BucketObjectLockConfiguration, CommitUploadOptions, CreateBucketOptions,
    CustomMetadata, DefaultRetention, DownloadOptions, ListBucketsOptions, ListObjectsOptions,
    ListUploadPartsOptions, ListUploadsOptions, Object, ObjectChecksum, ObjectChecksumAlgorithm,
    Part, Retention, RetentionMode, SetObjectRetentionOptions, SystemMetadata, UploadInfo,
    UploadOptions, verify_custom_metadata,
};
pub use upload::{Download, PartUpload, Upload};

/// Crate version from `Cargo.toml`.
pub fn version() -> &'static str {
    env!("CARGO_PKG_VERSION")
}

const _: () = {
    fn assert_send_sync<T: Send + Sync>() {}
    #[allow(dead_code)]
    fn _assert() {
        assert_send_sync::<Access>();
        assert_send_sync::<Project>();
        assert_send_sync::<Config>();
        assert_send_sync::<Upload>();
        assert_send_sync::<Download>();
        assert_send_sync::<Error>();
        assert_send_sync::<EncryptionKey>();
        assert_send_sync::<PartUpload>();
        assert_send_sync::<Permission>();
        assert_send_sync::<Object>();
        assert_send_sync::<Bucket>();
    }
};