spinners_rs/
lib.rs

1#![warn(missing_docs)]
2//! # Spinners for Rust
3//!
4//! [![Cargo version](https://img.shields.io/crates/v/spinners-rs.svg)](https://crates.io/crates/spinners-rs)
5//! [![License](https://img.shields.io/crates/l/spinners-rs)](https://github.com/jewlexx/spinners-rs/blob/master/LICENSE)
6//! [![Docs](https://img.shields.io/docsrs/spinners-rs)](https://docs.rs/spinners-rs/)
7//! [![Downloads](https://img.shields.io/crates/d/spinners-rs.svg)](https://crates.io/crates/spinners-rs)
8//!
9//! A lightweight collection of 80+ spinners for Rust, designed for speed and minimal overhead.
10//!
11//! ## Basic Example
12//!
13//! ```rust
14//! use std::{thread, time::Duration};
15//! use spinners_rs::{Spinner, Spinners};
16//!
17//! let mut sp = Spinner::new(Spinners::Arrow, "Doing Some Things...");
18//!
19//! sp.start();
20//!
21//! thread::sleep(Duration::from_secs(3));
22//! ```
23
24// All of the actual code is stored in other files
25// This is the main file that includes the code for the Spinner struct
26mod spinner;
27// This is the file that includes all the data for the spinners like the spinner enum and the frames
28mod spinners;
29
30pub use spinner::*;
31pub use spinners::*;