mirror of
https://github.com/alexpasmantier/television.git
synced 2025-06-19 18:00:13 +00:00
130 lines
4.0 KiB
Rust
130 lines
4.0 KiB
Rust
use devicons::FileIcon;
|
|
|
|
use crate::previewers::PreviewType;
|
|
|
|
// NOTE: having an enum for entry types would be nice since it would allow
|
|
// having a nicer implementation for transitions between channels. This would
|
|
// permit implementing `From<EntryType>` for channels which would make the
|
|
// channel convertible from any other that yields `EntryType`.
|
|
// This needs pondering since it does bring another level of abstraction and
|
|
// adds a layer of complexity.
|
|
#[derive(Clone, Debug, Eq, PartialEq, Hash)]
|
|
pub struct Entry {
|
|
/// The name of the entry.
|
|
pub name: String,
|
|
/// The display name of the entry.
|
|
display_name: Option<String>,
|
|
/// An optional value associated with the entry.
|
|
pub value: Option<String>,
|
|
/// The optional ranges for matching characters in the name.
|
|
pub name_match_ranges: Option<Vec<(u32, u32)>>,
|
|
/// The optional ranges for matching characters in the value.
|
|
pub value_match_ranges: Option<Vec<(u32, u32)>>,
|
|
/// The optional icon associated with the entry.
|
|
pub icon: Option<FileIcon>,
|
|
/// The optional line number associated with the entry.
|
|
pub line_number: Option<usize>,
|
|
/// The type of preview associated with the entry.
|
|
pub preview_type: PreviewType,
|
|
}
|
|
|
|
impl Entry {
|
|
/// Create a new entry with the given name and preview type.
|
|
///
|
|
/// Additional fields can be set using the builder pattern.
|
|
/// ```
|
|
/// use television::entry::{Entry, PreviewType};
|
|
/// use television::devicons::FileIcon;
|
|
///
|
|
/// let entry = Entry::new("name".to_string(), PreviewType::EnvVar)
|
|
/// .with_display_name("display_name".to_string())
|
|
/// .with_value("value".to_string())
|
|
/// .with_name_match_ranges(vec![(0, 1)])
|
|
/// .with_value_match_ranges(vec![(0, 1)])
|
|
/// .with_icon(FileIcon::default())
|
|
/// .with_line_number(0);
|
|
/// ```
|
|
///
|
|
/// # Arguments
|
|
/// * `name` - The name of the entry.
|
|
/// * `preview_type` - The type of preview associated with the entry.
|
|
///
|
|
/// # Returns
|
|
/// A new entry with the given name and preview type.
|
|
/// The other fields are set to `None` by default.
|
|
pub fn new(name: String, preview_type: PreviewType) -> Self {
|
|
Self {
|
|
name,
|
|
display_name: None,
|
|
value: None,
|
|
name_match_ranges: None,
|
|
value_match_ranges: None,
|
|
icon: None,
|
|
line_number: None,
|
|
preview_type,
|
|
}
|
|
}
|
|
|
|
pub fn with_display_name(mut self, display_name: String) -> Self {
|
|
self.display_name = Some(display_name);
|
|
self
|
|
}
|
|
|
|
pub fn with_value(mut self, value: String) -> Self {
|
|
self.value = Some(value);
|
|
self
|
|
}
|
|
|
|
pub fn with_name_match_ranges(
|
|
mut self,
|
|
name_match_ranges: Vec<(u32, u32)>,
|
|
) -> Self {
|
|
self.name_match_ranges = Some(name_match_ranges);
|
|
self
|
|
}
|
|
|
|
pub fn with_value_match_ranges(
|
|
mut self,
|
|
value_match_ranges: Vec<(u32, u32)>,
|
|
) -> Self {
|
|
self.value_match_ranges = Some(value_match_ranges);
|
|
self
|
|
}
|
|
|
|
pub fn with_icon(mut self, icon: FileIcon) -> Self {
|
|
self.icon = Some(icon);
|
|
self
|
|
}
|
|
|
|
pub fn with_line_number(mut self, line_number: usize) -> Self {
|
|
self.line_number = Some(line_number);
|
|
self
|
|
}
|
|
|
|
pub fn display_name(&self) -> &str {
|
|
self.display_name.as_ref().unwrap_or(&self.name)
|
|
}
|
|
|
|
pub fn stdout_repr(&self) -> String {
|
|
let mut repr = self.name.clone();
|
|
if let Some(line_number) = self.line_number {
|
|
repr.push_str(&format!(":{line_number}"));
|
|
}
|
|
if let Some(preview) = &self.value {
|
|
repr.push_str(&format!("\n{preview}"));
|
|
}
|
|
repr
|
|
}
|
|
}
|
|
|
|
pub const ENTRY_PLACEHOLDER: Entry = Entry {
|
|
name: String::new(),
|
|
display_name: None,
|
|
value: None,
|
|
name_match_ranges: None,
|
|
value_match_ranges: None,
|
|
icon: None,
|
|
line_number: None,
|
|
preview_type: PreviewType::EnvVar,
|
|
};
|