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 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
//! This crate allows printing broken UTF-8 bytes to an output stream as
//! losslessly as possible.
//!
//! Usually, paths are printed by calling [`Path::display`] or
//! [`Path::to_string_lossy`] beforehand. However, both of these methods are
//! always lossy; they misrepresent some valid paths in output. The same is
//! true when using [`String::from_utf8_lossy`] to print any other
//! UTF-8–like byte sequence.
//!
//! Instead, this crate only performs a lossy conversion when the output device
//! is known to require Unicode, to make output as accurate as possible. When
//! necessary, any character sequence that cannot be represented will be
//! replaced with [`REPLACEMENT_CHARACTER`]. That convention is shared with the
//! standard library, which uses the same character for its lossy conversion
//! functions.
//!
//! ### Note: Windows Compatibility
//!
//! [`OsStr`] and related structs may be printed lossily on Windows. Paths are
//! not represented using bytes on that platform, so it may be confusing to
//! display them in that manner. Plus, the encoding most often used to account
//! for the difference is [not permitted to be written to
//! files][wtf8_audience], so it would not make sense for this crate to use it.
//!
//! Windows Console can display these paths, so this crate will output them
//! losslessly when writing to that terminal.
//!
//! # Features
//!
//! These features are optional and can be enabled or disabled in a
//! "Cargo.toml" file.
//!
//! ### Optional Features
//!
//! - **os\_str\_bytes** -
//! Provides implementations of [`ToBytes`] for:
//! - [`OsStr`]
//! - [`OsString`]
//! - [`Path`]
//! - [`PathBuf`]
//!
//! ### Nightly Features
//!
//! These features are unstable, since they rely on unstable Rust features.
//!
//! - **specialization** -
//! Provides an implementation of [`WriteLossy`] for all types.
//!
//! # Examples
//!
//! ```
//! use std::env;
//! # use std::io;
//!
//! use print_bytes::println_lossy;
//!
//! print!("exe: ");
//! # #[cfg(feature = "os_str_bytes")]
//! println_lossy(&env::current_exe()?);
//! println!();
//!
//! println!("args:");
//! for arg in env::args_os().skip(1) {
//! # #[cfg(feature = "os_str_bytes")]
//! println_lossy(&arg);
//! }
//! #
//! # Ok::<_, io::Error>(())
//! ```
//!
//! [`OsStr`]: ::std::ffi::OsStr
//! [`OsString`]: ::std::ffi::OsString
//! [`Path`]: ::std::path::Path
//! [`Path::display`]: ::std::path::Path::display
//! [`Path::to_string_lossy`]: ::std::path::Path::to_string_lossy
//! [`PathBuf`]: ::std::path::PathBuf
//! [`REPLACEMENT_CHARACTER`]: char::REPLACEMENT_CHARACTER
//! [wtf8_audience]: https://simonsapin.github.io/wtf-8/#intended-audience
#![cfg_attr(feature = "specialization", allow(incomplete_features))]
// Only require a nightly compiler when building documentation for docs.rs.
// This is a private option that should not be used.
// https://github.com/rust-lang/docs.rs/issues/147#issuecomment-389544407
#![cfg_attr(print_bytes_docs_rs, feature(doc_cfg))]
#![cfg_attr(feature = "specialization", feature(specialization))]
#![warn(unused_results)]
use std::io;
use std::io::Write;
mod bytes;
pub use bytes::ByteStr;
use bytes::ByteStrInner;
pub use bytes::ToBytes;
#[cfg(any(doc, windows))]
pub use bytes::WideStr;
#[cfg(windows)]
mod console;
#[cfg_attr(test, macro_use)]
mod writer;
pub use writer::WriteLossy;
#[cfg(test)]
mod tests;
/// Writes a value to a "writer".
///
/// This function is similar to [`write!`] but does not take a format
/// parameter.
///
/// For more information, see [the module-level documentation][module].
///
/// # Errors
///
/// Returns an error if writing to the writer fails.
///
/// # Examples
///
/// ```
/// use std::env;
/// use std::ffi::OsStr;
///
/// use print_bytes::write_lossy;
///
/// let string = "foobar";
/// let os_string = OsStr::new(string);
///
/// # #[cfg(feature = "os_str_bytes")]
/// # {
/// let mut lossy_string = Vec::new();
/// write_lossy(&mut lossy_string, os_string)
/// .expect("failed writing to vector");
/// assert_eq!(string.as_bytes(), lossy_string);
/// # }
/// ```
///
/// [module]: self
#[inline]
pub fn write_lossy<T, W>(mut writer: W, value: &T) -> io::Result<()>
where
T: ?Sized + ToBytes,
W: Write + WriteLossy,
{
#[cfg(windows)]
let lossy = if let Some(mut console) = writer.__to_console() {
if let Some(string) = value.to_wide() {
return console.write_wide_all(&string.0);
}
true
} else {
false
};
#[cfg(windows)]
let buffer;
let string = value.to_bytes().0;
#[cfg_attr(not(windows), allow(clippy::infallible_destructuring_match))]
let string = match &string {
ByteStrInner::Bytes(string) => {
#[cfg(windows)]
if lossy {
buffer = String::from_utf8_lossy(string);
buffer.as_bytes()
} else {
string
}
#[cfg(not(windows))]
string
}
#[cfg(windows)]
ByteStrInner::Str(string) => string.as_bytes(),
};
writer.write_all(string)
}
macro_rules! expect_print {
( $label:literal , $result:expr ) => {
$result
.unwrap_or_else(|x| panic!("failed writing to {}: {}", $label, x))
};
}
macro_rules! r#impl {
(
$writer:expr ,
$(#[ $print_fn_attr:meta ])* $print_fn:ident ,
$(#[ $println_fn_attr:meta ])* $println_fn:ident ,
$label:literal ,
) => {
#[inline]
$(#[$print_fn_attr])*
pub fn $print_fn<T>(value: &T)
where
T: ?Sized + ToBytes,
{
expect_print!($label, write_lossy($writer, value));
}
#[inline]
$(#[$println_fn_attr])*
pub fn $println_fn<T>(value: &T)
where
T: ?Sized + ToBytes,
{
let mut writer = $writer.lock();
expect_print!($label, write_lossy(&mut writer, value));
expect_print!($label, writer.write_all(b"\n"));
}
};
}
r#impl!(
io::stderr(),
/// Prints a value to the standard error stream.
///
/// This function is similar to [`eprint!`] but does not take a format
/// parameter.
///
/// For more information, see [the module-level documentation][module].
///
/// # Panics
///
/// Panics if writing to the stream fails.
///
/// # Examples
///
/// ```
/// use std::env;
/// # use std::io;
///
/// use print_bytes::eprint_lossy;
///
/// # #[cfg(feature = "os_str_bytes")]
/// eprint_lossy(&env::current_exe()?);
/// #
/// # Ok::<_, io::Error>(())
/// ```
///
/// [module]: self
eprint_lossy,
/// Prints a value to the standard error stream, followed by a newline.
///
/// This function is similar to [`eprintln!`] but does not take a format
/// parameter.
///
/// For more information, see [the module-level documentation][module].
///
/// # Panics
///
/// Panics if writing to the stream fails.
///
/// # Examples
///
/// ```
/// use std::env;
/// # use std::io;
///
/// use print_bytes::eprintln_lossy;
///
/// # #[cfg(feature = "os_str_bytes")]
/// eprintln_lossy(&env::current_exe()?);
/// #
/// # Ok::<_, io::Error>(())
/// ```
///
/// [module]: self
eprintln_lossy,
"stderr",
);
r#impl!(
io::stdout(),
/// Prints a value to the standard output stream.
///
/// This function is similar to [`print!`] but does not take a format
/// parameter.
///
/// For more information, see [the module-level documentation][module].
///
/// # Panics
///
/// Panics if writing to the stream fails.
///
/// # Examples
///
/// ```
/// use std::env;
/// # use std::io;
///
/// use print_bytes::print_lossy;
///
/// # #[cfg(feature = "os_str_bytes")]
/// print_lossy(&env::current_exe()?);
/// #
/// # Ok::<_, io::Error>(())
/// ```
///
/// [module]: self
print_lossy,
/// Prints a value to the standard output stream, followed by a newline.
///
/// This function is similar to [`println!`] but does not take a format
/// parameter.
///
/// For more information, see [the module-level documentation][module].
///
/// # Panics
///
/// Panics if writing to the stream fails.
///
/// # Examples
///
/// ```
/// use std::env;
/// # use std::io;
///
/// use print_bytes::println_lossy;
///
/// # #[cfg(feature = "os_str_bytes")]
/// println_lossy(&env::current_exe()?);
/// #
/// # Ok::<_, io::Error>(())
/// ```
///
/// [module]: self
println_lossy,
"stdout",
);