rahmen 0.2.0

Rahmen is a lightweight image presenter
Documentation 
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

//! Configuration data for Rahmen

use serde::Deserialize;

/// An element of the status line
#[derive(Debug, Deserialize, Clone)]
pub struct Element {
    /// Capitalize the words in the tag (optional)
    pub capitalize: Option<bool>,
    /// Collection of exif tags, ordered by priority (mandatory)
    pub exif_tags: Vec<String>,
    /// Optional regex pattern and its replacement
    pub replace: Option<Vec<Replacement>>,
    /// Optional case conversion instruction
    pub case_conversion: Option<CaseConversion>,
}

/// case conversion
#[derive(Debug, Deserialize, Clone)]
pub struct CaseConversion {
    /// from case
    pub from: String,
    /// to case
    pub to: String,
}

/// replacement regular expression and value
#[derive(Debug, Deserialize, Clone)]
pub struct Replacement {
    /// the regular expression to use
    pub regex: String,
    /// the replacement for the regex match
    pub replace: String,
}

/// Config file root structure
#[derive(Debug, Default, Deserialize, Clone)]
// this is called in rahmen.rs where a new status line formatter is constructed
pub struct Settings {
    /// Transition delay between images (optional)
    pub delay: Option<f64>,
    /// Font size of the status line (optional)
    pub font_size: Option<f32>,
    /// Python module paths
    pub py_path: Option<Vec<String>>,
    /// python code to postprocess the status line
    pub py_postprocess: Option<String>,
    /// the separator that will be inserted between every element (metadata) of the
    /// status line (optional, but default is to insert ", ")
    pub separator: Option<String>,
    /// Status line: a collection of  elements (metadata tags, mandatory)
    pub status_line: Vec<Element>,
    /// Show the time in the status line
    pub display_time: Option<bool>,
    /// Time format string
    pub time_format: Option<String>,
}