rusty_cat/lib.rs
1//! `rusty-cat` public SDK crate.
2//!
3//! This crate exposes high-level APIs to enqueue and control upload/download
4//! tasks with breakpoint resume support.
5//!
6//! For beginners, start from [`api`] or directly use [`meow_client::MeowClient`]
7//! and [`meow_config::MeowConfig`].
8//!
9//! # Quick example
10//!
11//! ```no_run
12//! use rusty_cat::api::{MeowClient, MeowConfig, UploadPounceBuilder};
13//!
14//! let client = MeowClient::new(MeowConfig::new(2, 2));
15//! let _task = UploadPounceBuilder::new("file.bin", "./file.bin", 1024 * 1024)
16//! .with_url("https://example.com/upload")
17//! .build()
18//! .expect("source file must exist for this example");
19//! let _ = client;
20//! ```
21pub mod api;
22pub mod chunk_outcome;
23pub(crate) mod dflt;
24pub mod direction;
25pub mod down_pounce_builder;
26mod download_trait;
27pub mod error;
28pub mod file_transfer_record;
29pub mod http_breakpoint;
30pub mod ids;
31pub(crate) mod inner;
32pub mod log;
33pub mod meow_client;
34pub mod meow_config;
35pub mod pounce_task;
36pub mod prepare_outcome;
37pub mod transfer_executor_trait;
38pub mod transfer_snapshot;
39pub mod transfer_status;
40pub mod transfer_task;
41pub mod up_pounce_builder;
42pub(crate) mod upload_source;
43pub mod upload_trait;
44
45pub use api::*;