tab-api 0.5.6

the common api module for the tab terminal multiplexer
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
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

//! Common metadata about Tabs.

use lifeline::impl_storage_clone;
use serde::{Deserialize, Serialize};
use std::{collections::HashMap, fmt::Display, num::ParseIntError, str::FromStr};

pub fn normalize_name(name: &str) -> String {
    let name = name.to_string().trim().to_string();
    if name.ends_with("/") {
        name
    } else {
        name + "/"
    }
}

pub fn validate_tab_name(name: String) -> Result<(), String> {
    if name.starts_with('-') {
        return Err("tab name may not begin with a dash".into());
    }

    if name.contains(' ') || name.contains('\t') || name.contains('\r') || name.contains('\n') {
        return Err("tab name may not contain whitespace".into());
    }

    if name.contains('\\') {
        return Err("tab name may not contain backslashes".into());
    }

    Ok(())
}

/// Identifies a running tab using a numeric index.
#[derive(Serialize, Deserialize, Copy, Clone, Debug, Hash, PartialEq, Eq)]
pub struct TabId(pub u16);
impl_storage_clone!(TabId);

impl FromStr for TabId {
    type Err = ParseIntError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let id = u16::from_str(s)?;
        Ok(Self(id))
    }
}

impl Display for TabId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str("TabId(")?;
        self.0.fmt(f)?;
        f.write_str(")")?;

        Ok(())
    }
}

/// Tracked information about a running tab.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct TabMetadata {
    pub id: TabId,
    pub name: String,
    pub doc: Option<String>,
    pub dimensions: (u16, u16),
    pub env: HashMap<String, String>,
    pub shell: String,
    pub dir: String,
}

impl TabMetadata {
    pub fn create(id: TabId, create: CreateTabMetadata) -> Self {
        Self {
            id,
            name: create.name,
            doc: create.doc,
            dimensions: create.dimensions,
            env: create.env,
            shell: create.shell,
            dir: create.dir,
        }
    }
}

/// Information about a tab which will be created.
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq)]
pub struct CreateTabMetadata {
    pub name: String,
    pub dimensions: (u16, u16),
    pub doc: Option<String>,
    pub env: HashMap<String, String>,
    pub shell: String,
    pub dir: String,
}