You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

93 lines
2.4 KiB

#![cfg_attr(nightly, feature(never_type))]
#![allow(dead_code)]
macro_rules! flush {
($stream:expr) => {
{
#![allow(unused_imports)]
use std::io::Write;
let _ = $stream.flush();
}
};
() => {
use std::io::Write;
let _ = ::std::io::stdout().flush();
};
(? $stream:expr) => {
{
#[allow(unused_imports)]
use std::io::Write;
$stream.flush()
}
};
(?) => {
use std::io::Write;
::std::io::stdout().flush()
};
}
/// The default place to write bars to if an output is not user-specified.
pub(crate) type DefaultOutputDevice = std::io::Stdout;
/// A function that creates the default output device object for constructing a progress bar.
///
/// This must return multiple handles, since multiple bars can exist throughout the program at overlapping lifetimes.
/// `DefaultOutputDevice` should internally manage this state.
pub(crate) const CREATE_DEFAULT_OUTPUT_DEVICE_FUNC: fn () -> DefaultOutputDevice = std::io::stdout;
/// Create an object for the default output device.
#[inline]
pub(crate) fn create_default_output_device() -> DefaultOutputDevice
{
CREATE_DEFAULT_OUTPUT_DEVICE_FUNC()
}
#[cfg(feature="size")]
#[inline(always)]
fn terminal_size_of(f: &(impl AsRawFd + ?Sized)) -> Option<(terminal_size::Width, terminal_size::Height)>
{
terminal_size::terminal_size_using_fd(f.as_raw_fd())
}
use atomic_refcell::AtomicRefCell;
//#[cfg(feature="size")] TODO: How to add `AsRawFd` bound to `Bar` *only* when `size` feature is enabled?
use std::os::unix::io::*;
mod util;
mod inter;
pub use inter::*;
pub mod progress;
pub mod wheel;
pub mod spinner;
pub mod silent;
/// Returns true if `stdout` has a terminal output and can be used with terminal size responsiveness.
///
/// Requires `size` feature.
#[cfg(feature="size")]
pub fn has_terminal_output_default() -> bool
{
terminal_size::terminal_size().is_some()
}
/// Returns true if `f` has a terminal output and can be used with terminal size responsiveness.
///
/// Requires `size` feature.
#[cfg(feature="size")]
pub fn has_terminal_output(f: &(impl AsRawFd + ?Sized)) -> bool
{
terminal_size::terminal_size_using_fd(f.as_raw_fd()).is_some()
}
/// The prelude exposes the traits for spinners and progress bars, and the `spinner::Spin` and `progress::Bar` types for easy access and use.
pub mod prelude {
pub use super::inter::*;
pub use super::{
spinner::Spin,
progress::Bar,
silent::Silent,
};
}