eta 0.2.2

Tracks progress on repetive tasks and measures estimated remaining times.
Documentation
  • Coverage
  • 100%
    13 out of 13 items documented7 out of 9 items with examples
  • Size
  • Source code size: 194.04 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 1.85 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 9s Average build duration of successful builds.
  • all releases: 9s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • aaarkid/eta
    3 0 5
  • crates.io
  • Dependencies
    • —
  • Versions
  • Owners
  • aaarkid

About The Project

ETA aims to be a simple, easy to use, and efficient library for tracking progress on repetitive tasks. The main purpose of ETA is to measure remaining time, but it's being develop to include progress tracking and progress bar display too.

Built With

Rust

Getting started

Add this to your Cargo.toml:

[dependencies]
eta = "0.2.2"

Add this to your source code:

use eta::{ETA, TimeAcc};

Usage

Usage is revolved around the Eta Object which implements a number of functions.

Initialize Eta in two ways:

  • with new(TasksCount, TimeAccuracy) function where TasksCount is the number of tasks you want to track and TimeAccuracy is the accuracy of the time measurement.
  • with in_progress(TasksCount, TasksDone, TimeAccuracy) function where TasksDone is the number of tasks that have completed.

TimeAccuracy can be one of the following:

  • TimeAcc::SEC
  • TimeAcc::MILLI
  • TimeAcc::MICRO
  • TimeAcc::NANO

Run step() function on every iteration of your task.

    let mut eta = Eta::new(10, TimeSteps::MILLI);

    for i in 0..10 {
        do_some_function();
        eta.step();
    }

For more examples, please refer to the Documentation

Roadmap

  • Enable to pause and resume time tracking
  • Ability to calculate weight of unequal tasks during development and create more accurate progress and ETA measurement.
  • Create more options for formatting output.
  • Add tolerance against outlier values.

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributing to this repository is greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Giving the project a star is much appreciated and means a lot! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MPL-2.0 license. See LICENSE.MD for more information.

Contact

@aaarkid - akaleci@jacobs-university.de