shrub-core 0.0.3

Reusable core of a POSIX/bash shell (used by shrub-shell)
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

//! Terminal utilities.

use crate::{error, openfiles, sys, terminal};

/// Terminal configuration.
#[derive(Clone, Debug)]
pub struct Config;

#[allow(clippy::unused_self)]
impl Config {
    /// Creates a new `Config` from the actual terminal attributes of the
    /// terminal associated with the given file descriptor.
    ///
    /// # Arguments
    ///
    /// * `_file` - A reference to the open terminal.
    ///
    /// # Errors
    ///
    /// This stub implementation always succeeds.
    pub fn from_term(_file: &openfiles::OpenFile) -> Result<Self, error::Error> {
        Ok(Self)
    }

    /// Applies the terminal settings to the terminal associated with the given
    /// file descriptor.
    ///
    /// # Arguments
    ///
    /// * `_file` - A reference to the open terminal.
    ///
    /// # Errors
    ///
    /// This stub implementation always succeeds.
    pub fn apply_to_term(&self, _file: &openfiles::OpenFile) -> Result<(), error::Error> {
        Ok(())
    }

    /// Applies the given high-level terminal settings to this configuration.
    /// Does not modify any terminal itself.
    ///
    /// # Arguments
    ///
    /// * `_settings` - The high-level terminal settings to apply to this
    ///   configuration.
    pub fn update(&mut self, _settings: &terminal::Settings) {}
}

/// Get the process ID of this process's parent.
///
/// This is a stub implementation that returns `None`.
pub fn get_parent_process_id() -> Option<sys::process::ProcessId> {
    None
}

/// Get the process group ID for this process's process group.
///
/// This is a stub implementation that returns `None`.
pub fn get_process_group_id() -> Option<sys::process::ProcessId> {
    None
}

/// Get the foreground process ID of the attached terminal.
///
/// This is a stub implementation that returns `None`.
pub fn get_foreground_pid() -> Option<sys::process::ProcessId> {
    None
}

/// Move the specified process to the foreground of the attached terminal.
///
/// This is a stub implementation that takes no action.
///
/// # Errors
///
/// This stub implementation always succeeds.
pub fn move_to_foreground(_pid: sys::process::ProcessId) -> Result<(), error::Error> {
    Ok(())
}

/// Moves the current process to the foreground of the attached terminal.
///
/// This is a stub implementation that returns `None`.
///
/// # Errors
///
/// This stub implementation always succeeds.
pub fn move_self_to_foreground() -> Result<(), std::io::Error> {
    Ok(())
}

/// Tries to get the path of the terminal device associated with the attached
/// terminal.
///
/// This is a stub implementation that always returns `None`.
pub fn try_get_terminal_device_path() -> Option<std::path::PathBuf> {
    None
}

/// Returns the width, in columns, of the terminal associated with the given
/// file.
///
/// This is a stub implementation that always returns `None`.
pub const fn get_columns(_file: &openfiles::OpenFile) -> Option<usize> {
    None
}