MirroredRepos/bat
1
0
Fork 0
mirror of https://github.com/sharkdp/bat.git synced 2025-01-19 04:21:06 +00:00
Code Issues Releases Wiki Activity

Add documentation to InputDescription

Browse Source
This commit is contained in:
Ethan P 2020-05-15 14:21:38 -07:00 committed by David Peter
parent 268c0963b4
commit 384ea38bd9
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/input.rs
View File

@ -8,10 +8,17 @@ use crate::error::*;
const THEME_PREVIEW_FILE: &[u8] = include_bytes!("../assets/theme_preview.rs"); const THEME_PREVIEW_FILE: &[u8] = include_bytes!("../assets/theme_preview.rs");
/// A description for an Input source.
/// This tells bat how to refer to the input.
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub(crate) struct InputDescription { pub(crate) struct InputDescription {
/// The name of the input used when printing warnings.
pub full: String, pub full: String,
/// The prefix string for the input when displaying it in the header.
pub prefix: String, pub prefix: String,
/// The name of the input.
pub name: String, pub name: String,
} }