Add #![warn(unreachable_pub)] and appease

tamird · djc · commit 383fcceca7b3 · 2024-12-17T13:35:26.000+01:00
diff --git a/src/ansi.rs b/src/ansi.rs
@@ -125,7 +125,7 @@ struct Match<'a> {
 
 impl<'a> Match<'a> {
     #[inline]
-    pub fn as_str(&self) -> &'a str {
+    pub(crate) fn as_str(&self) -> &'a str {
         &self.text[self.start..self.end]
     }
 }
diff --git a/src/common_term.rs b/src/common_term.rs
@@ -2,30 +2,30 @@ use std::io;
 
 use crate::term::Term;
 
-pub fn move_cursor_down(out: &Term, n: usize) -> io::Result<()> {
+pub(crate) fn move_cursor_down(out: &Term, n: usize) -> io::Result<()> {
     if n > 0 {
         out.write_str(&format!("\x1b[{}B", n))
     } else {
         Ok(())
     }
 }
 
-pub fn move_cursor_up(out: &Term, n: usize) -> io::Result<()> {
+pub(crate) fn move_cursor_up(out: &Term, n: usize) -> io::Result<()> {
     if n > 0 {
         out.write_str(&format!("\x1b[{}A", n))
     } else {
         Ok(())
     }
 }
-pub fn move_cursor_left(out: &Term, n: usize) -> io::Result<()> {
+pub(crate) fn move_cursor_left(out: &Term, n: usize) -> io::Result<()> {
     if n > 0 {
         out.write_str(&format!("\x1b[{}D", n))
     } else {
         Ok(())
     }
 }
 
-pub fn move_cursor_right(out: &Term, n: usize) -> io::Result<()> {
+pub(crate) fn move_cursor_right(out: &Term, n: usize) -> io::Result<()> {
     if n > 0 {
         out.write_str(&format!("\x1b[{}C", n))
     } else {
@@ -34,11 +34,11 @@ pub fn move_cursor_right(out: &Term, n: usize) -> io::Result<()> {
 }
 
 #[inline]
-pub fn move_cursor_to(out: &Term, x: usize, y: usize) -> io::Result<()> {
+pub(crate) fn move_cursor_to(out: &Term, x: usize, y: usize) -> io::Result<()> {
     out.write_str(&format!("\x1B[{};{}H", y + 1, x + 1))
 }
 
-pub fn clear_chars(out: &Term, n: usize) -> io::Result<()> {
+pub(crate) fn clear_chars(out: &Term, n: usize) -> io::Result<()> {
     if n > 0 {
         out.write_str(&format!("\x1b[{}D\x1b[0K", n))
     } else {
@@ -47,26 +47,26 @@ pub fn clear_chars(out: &Term, n: usize) -> io::Result<()> {
 }
 
 #[inline]
-pub fn clear_line(out: &Term) -> io::Result<()> {
+pub(crate) fn clear_line(out: &Term) -> io::Result<()> {
     out.write_str("\r\x1b[2K")
 }
 
 #[inline]
-pub fn clear_screen(out: &Term) -> io::Result<()> {
+pub(crate) fn clear_screen(out: &Term) -> io::Result<()> {
     out.write_str("\r\x1b[2J\r\x1b[H")
 }
 
 #[inline]
-pub fn clear_to_end_of_screen(out: &Term) -> io::Result<()> {
+pub(crate) fn clear_to_end_of_screen(out: &Term) -> io::Result<()> {
     out.write_str("\r\x1b[0J")
 }
 
 #[inline]
-pub fn show_cursor(out: &Term) -> io::Result<()> {
+pub(crate) fn show_cursor(out: &Term) -> io::Result<()> {
     out.write_str("\x1b[?25h")
 }
 
 #[inline]
-pub fn hide_cursor(out: &Term) -> io::Result<()> {
+pub(crate) fn hide_cursor(out: &Term) -> io::Result<()> {
     out.write_str("\x1b[?25l")
 }
diff --git a/src/lib.rs b/src/lib.rs
@@ -76,6 +76,8 @@
 //!   for stripping and taking ansi escape codes into account for length
 //!   calculations).
 
+#![warn(unreachable_pub)]
+
 pub use crate::kb::Key;
 pub use crate::term::{
     user_attended, user_attended_stderr, Term, TermFamily, TermFeatures, TermTarget,
diff --git a/src/term.rs b/src/term.rs
@@ -38,7 +38,7 @@ pub enum TermTarget {
 }
 
 #[derive(Debug)]
-pub struct TermInner {
+struct TermInner {
     target: TermTarget,
     buffer: Option<Mutex<Vec<u8>>>,
     prompt: RwLock<String>,
@@ -657,8 +657,8 @@ impl Read for &Term {
 }
 
 #[cfg(all(unix, not(target_arch = "wasm32")))]
-pub use crate::unix_term::*;
+pub(crate) use crate::unix_term::*;
 #[cfg(target_arch = "wasm32")]
-pub use crate::wasm_term::*;
+pub(crate) use crate::wasm_term::*;
 #[cfg(windows)]
-pub use crate::windows_term::*;
+pub(crate) use crate::windows_term::*;
diff --git a/src/unix_term.rs b/src/unix_term.rs
@@ -13,16 +13,16 @@ use once_cell::sync::Lazy;
 use crate::kb::Key;
 use crate::term::Term;
 
-pub use crate::common_term::*;
+pub(crate) use crate::common_term::*;
 
-pub const DEFAULT_WIDTH: u16 = 80;
+pub(crate) const DEFAULT_WIDTH: u16 = 80;
 
 #[inline]
-pub fn is_a_terminal(out: &Term) -> bool {
+pub(crate) fn is_a_terminal(out: &Term) -> bool {
     unsafe { libc::isatty(out.as_raw_fd()) != 0 }
 }
 
-pub fn is_a_color_terminal(out: &Term) -> bool {
+pub(crate) fn is_a_color_terminal(out: &Term) -> bool {
     if !is_a_terminal(out) {
         return false;
     }
@@ -37,7 +37,7 @@ pub fn is_a_color_terminal(out: &Term) -> bool {
     }
 }
 
-pub fn c_result<F: FnOnce() -> libc::c_int>(f: F) -> io::Result<()> {
+fn c_result<F: FnOnce() -> libc::c_int>(f: F) -> io::Result<()> {
     let res = f();
     if res != 0 {
         Err(io::Error::last_os_error())
@@ -46,7 +46,7 @@ pub fn c_result<F: FnOnce() -> libc::c_int>(f: F) -> io::Result<()> {
     }
 }
 
-pub fn terminal_size(out: &Term) -> Option<(u16, u16)> {
+pub(crate) fn terminal_size(out: &Term) -> Option<(u16, u16)> {
     unsafe {
         if libc::isatty(out.as_raw_fd()) != 1 {
             return None;
@@ -66,7 +66,7 @@ pub fn terminal_size(out: &Term) -> Option<(u16, u16)> {
     }
 }
 
-pub fn read_secure() -> io::Result<String> {
+pub(crate) fn read_secure() -> io::Result<String> {
     let mut f_tty;
     let fd = unsafe {
         if libc::isatty(libc::STDIN_FILENO) == 1 {
@@ -300,7 +300,7 @@ fn read_single_key_impl(fd: i32) -> Result<Key, io::Error> {
     }
 }
 
-pub fn read_single_key(ctrlc_key: bool) -> io::Result<Key> {
+pub(crate) fn read_single_key(ctrlc_key: bool) -> io::Result<Key> {
     let tty_f;
     let fd = unsafe {
         if libc::isatty(libc::STDIN_FILENO) == 1 {
@@ -339,7 +339,7 @@ pub fn read_single_key(ctrlc_key: bool) -> io::Result<Key> {
     rv
 }
 
-pub fn key_from_utf8(buf: &[u8]) -> Key {
+fn key_from_utf8(buf: &[u8]) -> Key {
     if let Ok(s) = str::from_utf8(buf) {
         if let Some(c) = s.chars().next() {
             return Key::Char(c);
@@ -355,15 +355,15 @@ static IS_LANG_UTF8: Lazy<bool> = Lazy::new(|| match std::env::var("LANG") {
 });
 
 #[cfg(target_os = "macos")]
-pub fn wants_emoji() -> bool {
+pub(crate) fn wants_emoji() -> bool {
     true
 }
 
 #[cfg(not(target_os = "macos"))]
-pub fn wants_emoji() -> bool {
+pub(crate) fn wants_emoji() -> bool {
     *IS_LANG_UTF8
 }
 
-pub fn set_title<T: Display>(title: T) {
+pub(crate) fn set_title<T: Display>(title: T) {
     print!("\x1b]0;{}\x07", title);
 }

Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ struct Match<'a> {`
`125`	`125`
`126`	`126`	`impl<'a> Match<'a> {`
`127`	`127`	`#[inline]`
`128`		`- pub fn as_str(&self) -> &'a str {`
	`128`	`+ pub(crate) fn as_str(&self) -> &'a str {`
`129`	`129`	`&self.text[self.start..self.end]`
`130`	`130`	`}`
`131`	`131`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,30 +2,30 @@ use std::io;`
`2`	`2`
`3`	`3`	`use crate::term::Term;`
`4`	`4`
`5`		`-pub fn move_cursor_down(out: &Term, n: usize) -> io::Result<()> {`
	`5`	`+pub(crate) fn move_cursor_down(out: &Term, n: usize) -> io::Result<()> {`
`6`	`6`	`if n > 0 {`
`7`	`7`	`out.write_str(&format!("\x1b[{}B", n))`
`8`	`8`	`} else {`
`9`	`9`	`Ok(())`
`10`	`10`	`}`
`11`	`11`	`}`
`12`	`12`
`13`		`-pub fn move_cursor_up(out: &Term, n: usize) -> io::Result<()> {`
	`13`	`+pub(crate) fn move_cursor_up(out: &Term, n: usize) -> io::Result<()> {`
`14`	`14`	`if n > 0 {`
`15`	`15`	`out.write_str(&format!("\x1b[{}A", n))`
`16`	`16`	`} else {`
`17`	`17`	`Ok(())`
`18`	`18`	`}`
`19`	`19`	`}`
`20`		`-pub fn move_cursor_left(out: &Term, n: usize) -> io::Result<()> {`
	`20`	`+pub(crate) fn move_cursor_left(out: &Term, n: usize) -> io::Result<()> {`
`21`	`21`	`if n > 0 {`
`22`	`22`	`out.write_str(&format!("\x1b[{}D", n))`
`23`	`23`	`} else {`
`24`	`24`	`Ok(())`
`25`	`25`	`}`
`26`	`26`	`}`
`27`	`27`
`28`		`-pub fn move_cursor_right(out: &Term, n: usize) -> io::Result<()> {`
	`28`	`+pub(crate) fn move_cursor_right(out: &Term, n: usize) -> io::Result<()> {`
`29`	`29`	`if n > 0 {`
`30`	`30`	`out.write_str(&format!("\x1b[{}C", n))`
`31`	`31`	`} else {`
`@@ -34,11 +34,11 @@ pub fn move_cursor_right(out: &Term, n: usize) -> io::Result<()> {`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`#[inline]`
`37`		`-pub fn move_cursor_to(out: &Term, x: usize, y: usize) -> io::Result<()> {`
	`37`	`+pub(crate) fn move_cursor_to(out: &Term, x: usize, y: usize) -> io::Result<()> {`
`38`	`38`	`out.write_str(&format!("\x1B[{};{}H", y + 1, x + 1))`
`39`	`39`	`}`
`40`	`40`
`41`		`-pub fn clear_chars(out: &Term, n: usize) -> io::Result<()> {`
	`41`	`+pub(crate) fn clear_chars(out: &Term, n: usize) -> io::Result<()> {`
`42`	`42`	`if n > 0 {`
`43`	`43`	`out.write_str(&format!("\x1b[{}D\x1b[0K", n))`
`44`	`44`	`} else {`
`@@ -47,26 +47,26 @@ pub fn clear_chars(out: &Term, n: usize) -> io::Result<()> {`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`#[inline]`
`50`		`-pub fn clear_line(out: &Term) -> io::Result<()> {`
	`50`	`+pub(crate) fn clear_line(out: &Term) -> io::Result<()> {`
`51`	`51`	`out.write_str("\r\x1b[2K")`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`#[inline]`
`55`		`-pub fn clear_screen(out: &Term) -> io::Result<()> {`
	`55`	`+pub(crate) fn clear_screen(out: &Term) -> io::Result<()> {`
`56`	`56`	`out.write_str("\r\x1b[2J\r\x1b[H")`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`#[inline]`
`60`		`-pub fn clear_to_end_of_screen(out: &Term) -> io::Result<()> {`
	`60`	`+pub(crate) fn clear_to_end_of_screen(out: &Term) -> io::Result<()> {`
`61`	`61`	`out.write_str("\r\x1b[0J")`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`#[inline]`
`65`		`-pub fn show_cursor(out: &Term) -> io::Result<()> {`
	`65`	`+pub(crate) fn show_cursor(out: &Term) -> io::Result<()> {`
`66`	`66`	`out.write_str("\x1b[?25h")`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`#[inline]`
`70`		`-pub fn hide_cursor(out: &Term) -> io::Result<()> {`
	`70`	`+pub(crate) fn hide_cursor(out: &Term) -> io::Result<()> {`
`71`	`71`	`out.write_str("\x1b[?25l")`
`72`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,16 +13,16 @@ use once_cell::sync::Lazy;`
`13`	`13`	`use crate::kb::Key;`
`14`	`14`	`use crate::term::Term;`
`15`	`15`
`16`		`-pub use crate::common_term::*;`
	`16`	`+pub(crate) use crate::common_term::*;`
`17`	`17`
`18`		`-pub const DEFAULT_WIDTH: u16 = 80;`
	`18`	`+pub(crate) const DEFAULT_WIDTH: u16 = 80;`
`19`	`19`
`20`	`20`	`#[inline]`
`21`		`-pub fn is_a_terminal(out: &Term) -> bool {`
	`21`	`+pub(crate) fn is_a_terminal(out: &Term) -> bool {`
`22`	`22`	`unsafe { libc::isatty(out.as_raw_fd()) != 0 }`
`23`	`23`	`}`
`24`	`24`
`25`		`-pub fn is_a_color_terminal(out: &Term) -> bool {`
	`25`	`+pub(crate) fn is_a_color_terminal(out: &Term) -> bool {`
`26`	`26`	`if !is_a_terminal(out) {`
`27`	`27`	`return false;`
`28`	`28`	`}`
`@@ -37,7 +37,7 @@ pub fn is_a_color_terminal(out: &Term) -> bool {`
`37`	`37`	`}`
`38`	`38`	`}`
`39`	`39`
`40`		`-pub fn c_result<F: FnOnce() -> libc::c_int>(f: F) -> io::Result<()> {`
	`40`	`+fn c_result<F: FnOnce() -> libc::c_int>(f: F) -> io::Result<()> {`
`41`	`41`	`let res = f();`
`42`	`42`	`if res != 0 {`
`43`	`43`	`Err(io::Error::last_os_error())`
`@@ -46,7 +46,7 @@ pub fn c_result<F: FnOnce() -> libc::c_int>(f: F) -> io::Result<()> {`
`46`	`46`	`}`
`47`	`47`	`}`
`48`	`48`
`49`		`-pub fn terminal_size(out: &Term) -> Option<(u16, u16)> {`
	`49`	`+pub(crate) fn terminal_size(out: &Term) -> Option<(u16, u16)> {`
`50`	`50`	`unsafe {`
`51`	`51`	`if libc::isatty(out.as_raw_fd()) != 1 {`
`52`	`52`	`return None;`
`@@ -66,7 +66,7 @@ pub fn terminal_size(out: &Term) -> Option<(u16, u16)> {`
`66`	`66`	`}`
`67`	`67`	`}`
`68`	`68`
`69`		`-pub fn read_secure() -> io::Result<String> {`
	`69`	`+pub(crate) fn read_secure() -> io::Result<String> {`
`70`	`70`	`let mut f_tty;`
`71`	`71`	`let fd = unsafe {`
`72`	`72`	`if libc::isatty(libc::STDIN_FILENO) == 1 {`
`@@ -300,7 +300,7 @@ fn read_single_key_impl(fd: i32) -> Result<Key, io::Error> {`
`300`	`300`	`}`
`301`	`301`	`}`
`302`	`302`
`303`		`-pub fn read_single_key(ctrlc_key: bool) -> io::Result<Key> {`
	`303`	`+pub(crate) fn read_single_key(ctrlc_key: bool) -> io::Result<Key> {`
`304`	`304`	`let tty_f;`
`305`	`305`	`let fd = unsafe {`
`306`	`306`	`if libc::isatty(libc::STDIN_FILENO) == 1 {`
`@@ -339,7 +339,7 @@ pub fn read_single_key(ctrlc_key: bool) -> io::Result<Key> {`
`339`	`339`	`rv`
`340`	`340`	`}`
`341`	`341`
`342`		`-pub fn key_from_utf8(buf: &[u8]) -> Key {`
	`342`	`+fn key_from_utf8(buf: &[u8]) -> Key {`
`343`	`343`	`if let Ok(s) = str::from_utf8(buf) {`
`344`	`344`	`if let Some(c) = s.chars().next() {`
`345`	`345`	`return Key::Char(c);`
`@@ -355,15 +355,15 @@ static IS_LANG_UTF8: Lazy<bool> = Lazy::new(\|\| match std::env::var("LANG") {`
`355`	`355`	`});`
`356`	`356`
`357`	`357`	`#[cfg(target_os = "macos")]`
`358`		`-pub fn wants_emoji() -> bool {`
	`358`	`+pub(crate) fn wants_emoji() -> bool {`
`359`	`359`	`true`
`360`	`360`	`}`
`361`	`361`
`362`	`362`	`#[cfg(not(target_os = "macos"))]`
`363`		`-pub fn wants_emoji() -> bool {`
	`363`	`+pub(crate) fn wants_emoji() -> bool {`
`364`	`364`	`*IS_LANG_UTF8`
`365`	`365`	`}`
`366`	`366`
`367`		`-pub fn set_title<T: Display>(title: T) {`
	`367`	`+pub(crate) fn set_title<T: Display>(title: T) {`
`368`	`368`	`print!("\x1b]0;{}\x07", title);`
`369`	`369`	`}`