1//! A simple utility for getting the size of a terminal.
2//!
3//! Works on Linux, macOS, Windows, and illumos.
4//!
5//! This crate requires a minimum Rust version of 1.63.0 (2022-08-11).
6//!
7//! # Example
8//!
9//! ```
10//! use terminal_size::{Width, Height, terminal_size};
11//!
12//! let size = terminal_size();
13//! if let Some((Width(w), Height(h))) = size {
14//! println!("Your terminal is {} cols wide and {} lines tall", w, h);
15//! } else {
16//! println!("Unable to get terminal size");
17//! }
18//! ```
19//!
20
21#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
22pub struct Width(pub u16);
23#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
24pub struct Height(pub u16);
25
26#[cfg(unix)]
27mod unix;
28#[cfg(unix)]
29#[allow(deprecated)]
30pub use crate::unix::{terminal_size, terminal_size_of, terminal_size_using_fd};
31
32#[cfg(windows)]
33mod windows;
34#[cfg(windows)]
35#[allow(deprecated)]
36pub use crate::windows::{terminal_size, terminal_size_of, terminal_size_using_handle};
37
38#[cfg(not(any(unix, windows)))]
39pub fn terminal_size() -> Option<(Width, Height)> {
40 None
41}
42