Files
paracas/crates/paracas-estimate/src/lib.rs
T
Andreas Bigger 3edf2d9ece 📚 docs: add missing READMEs and align crates with Rust rules
- Create README.md for paracas-daemon and paracas-estimate
- Add #![doc = include_str!("../README.md")] to daemon/estimate lib.rs
- Add missing Cargo.toml metadata (docs.rs, authors, keywords, categories)
- Reorder workspace dependencies by line length per style guide
- Document background jobs, download-all, status, and job commands
2025-12-29 18:02:56 -05:00

23 lines
947 B
Rust

//! Download size and time estimation for paracas tick data downloader.
//!
//! This crate provides utilities for estimating download sizes and times
//! based on historical averages for different instrument categories:
//!
//! - [`EstimateDatabase`] - Database of historical size estimates per category
//! - [`CategoryEstimate`] - Size estimates for a single category
//! - [`Estimator`] - Computes download estimates for instruments and date ranges
//! - [`DownloadEstimate`] - Estimated download metrics
//! - [`EstimateConfidence`] - Confidence level of the estimate
#![doc = include_str!("../README.md")]
#![doc(issue_tracker_base_url = "https://github.com/factordynamics/paracas/issues/")]
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
#![warn(missing_docs)]
#![forbid(unsafe_code)]
mod data;
mod estimator;
pub use data::{CategoryEstimate, EstimateDatabase};
pub use estimator::{DownloadEstimate, EstimateConfidence, Estimator};