mirror of
https://github.com/sharkdp/bat
synced 2024-11-15 00:12:57 +00:00
Add documentation to InputDescription
This commit is contained in:
parent
268c0963b4
commit
384ea38bd9
@ -8,10 +8,17 @@ use crate::error::*;
|
||||
|
||||
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)]
|
||||
pub(crate) struct InputDescription {
|
||||
/// The name of the input used when printing warnings.
|
||||
pub full: String,
|
||||
|
||||
/// The prefix string for the input when displaying it in the header.
|
||||
pub prefix: String,
|
||||
|
||||
/// The name of the input.
|
||||
pub name: String,
|
||||
}
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user