rcli-loader 0.1.0

RCLI-loader: The Rust client line interface loader crate, a utility built for versatile monitoring of the progress for running tasks
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210

<!-- README template by othneildrew -->

<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->

<a id="readme-top"></a>

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![project_license][license-shield]][license-url]



<!-- PROJECT LOGO -->

<br />
<div align="center">
  <a href="https://github.com/nikguin04/rcli-loader">
    <img src=".readme/FerrisLogo.gif" alt="Logo" width="200" height="200">
  </a>

<h3 align="center">RCli-Loader</h3>

  <p align="center">
    RCli-Loader - CLI loading interface, written in Rust!
    <!-- <br />
    <a href="https://github.com/nikguin04/rcli-loader"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://github.com/nikguin04/rcli-loader">View Demo</a>
    &middot;-->
    <br />
    <a href="https://github.com/nikguin04/rcli-loader/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
    &middot;
    <a href="https://github.com/nikguin04/rcli-loader/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
  </p>
</div>



<!-- TABLE OF CONTENTS -->

<details>
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#built-with">Built With</a></li>
      </ul>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <!-- <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul> -->
    </li>
    <li><a href="#usage">Usage</a></li>
    <!-- <li><a href="#roadmap">Roadmap</a></li>-->
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
    <!-- <li><a href="#acknowledgments">Acknowledgments</a></li>  -->
  </ol>
</details>



<!-- ABOUT THE PROJECT -->

## About The Project


[![rcli-loader product screenshot][product-screenshot]](https://github.com/nikguin04/rcli-loader)

The RCLI-Loader crate **(coming soon)** is a Rust CLI manager built for versatile monitoring of the progress for running tasks, either quick or slow!
<br /> A screenshot for an examplified implementation of the features can be seen below, including:
 - Names
 - Progress indicator (numbered)
    - Also features providing a scaling function for conversion of any wanted unit!
 - Progress indicator (block characters)
    - Scaling perfectly to the terminal size to give maximal precision (8 blocks per character available)!
 - Fully customizable colors for individual loading elements
    - Provide a custom function, or use an already created one, for determining the color setup of the loading elements.
    - Note: Currently only the numbered progress indicator supports colors
 - Custom alignment for loading elements: Place either aligning with top or bottom of terminal
 - Custom print function for logging, without overwriting the loading elements.
    - Note: Currently only supports printing regular UTF-8 characters, as line length is determined purely from byte count.

![rcli-loader running example](.readme/SS_example.png "Example of program running")

Even more features are coming, and feature requests are welcome: read <a href="#contributing">Contributing</a>

<p align="right">(<a href="#readme-top">back to top</a>)</p>



### Built With


* [![Rust][Rust]][Rust-url]

Built with pure rust, and a minimal amount of dependencies, to keep the crate as lightweight as possible. Currently the bare mininmum crate tree size is only 4. Tree size quickly goes up when using optional dependencies for running the example, such as tokio, reqwest, and humansize. These three crate make the crate tree size shoot up to 239.

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- GETTING STARTED -->

## Getting Started

<!--

### Prerequisites


### Installation-->


#### Running example

1. git clone https://github.com/nikguin04/rcli-loader.git
2. cd rcli-loader
3. cargo run --example basic_example --all-features

#### Implementing crate for your own project!

Coming soon

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- USAGE EXAMPLES -->

## Usage


Usage coming soon™

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- ROADMAP -->

<!--## Roadmap

- [ ] Feature 1
- [ ] Feature 2
- [ ] Feature 3
    - [ ] Nested Feature

See the [open issues](https://github.com/nikguin04/rcli-loader/issues) for a full list of proposed features (and known issues).

<p align="right">(<a href="#readme-top">back to top</a>)</p>-->




<!-- CONTRIBUTING -->

## Contributing


Currently i am the only contributor and maintainer of this project. Contributions of any kind are very welcome.

If you have any improvements please fork the repo and create a pull request here. Please make sure to properly describe any changes made in the pull request, so i am not 100% reliant on commit names, which usually are a bit messy ;) <br />
If this project has helped you, please give it a star!

<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- ### Top contributors:

<a href="https://github.com/nikguin04/rcli-loader/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=nikguin04/rcli-loader" alt="contrib.rocks image" />
</a> -->




<!-- LICENSE -->

## License


Distributed under the GNU General Public License v3.0 license. See `LICENSE.txt` for more information.

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- CONTACT -->

## Contact


For any contact regarding this repo, please contact me through email at nikguin04@proton.me or on the Discussions on this repository<br />
Project Link: [https://github.com/nikguin04/rcli-loader](https://github.com/nikguin04/rcli-loader)

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- ACKNOWLEDGMENTS -->

<!--## Acknowledgments

* []()
* []()
* []()

<p align="right">(<a href="#readme-top">back to top</a>)</p>-->




<!-- MARKDOWN LINKS & IMAGES -->

<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

[contributors-shield]: https://img.shields.io/github/contributors/nikguin04/rcli-loader.svg?style=for-the-badge
[contributors-url]: https://github.com/nikguin04/rcli-loader/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/nikguin04/rcli-loader.svg?style=for-the-badge
[forks-url]: https://github.com/nikguin04/rcli-loader/network/members
[stars-shield]: https://img.shields.io/github/stars/nikguin04/rcli-loader.svg?style=for-the-badge
[stars-url]: https://github.com/nikguin04/rcli-loader/stargazers
[issues-shield]: https://img.shields.io/github/issues/nikguin04/rcli-loader.svg?style=for-the-badge
[issues-url]: https://github.com/nikguin04/rcli-loader/issues
[license-shield]: https://img.shields.io/github/license/nikguin04/rcli-loader.svg?style=for-the-badge
[license-url]: https://github.com/nikguin04/rcli-loader/blob/master/LICENSE.txt
[product-screenshot]: .readme/FerrisSplash.png
[Rust]: https://img.shields.io/badge/Rust-%23F74C00.svg?e&logo=rust&logoColor=white
[Rust-url]: https://www.rust-lang.org/