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
107
108
109
110

/*
==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--

R50

Copyright (C) 2018-2019, 2021-2023  Anonymous

There are several releases over multiple years,
they are listed as ranges, such as: "2018-2019".

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

::--::--::--::--::--::--::--::--::--::--::--::--::--::--::--::--
*/

//! # R50
//!
//! ## Project
//!
//! - License: GNU Lesser General Public License, either version 3, or (at your option) any later version.
//! - _This project follows [Semantic Versioning 2.0.0]_
//!
//! ## Features
//!
//! This project helps with resource management of process(es) running on personal Linux machines.
//!
//! It provides 2 programs: a server, and a client.
//!
//! - The server program binds to an abstract Linux socket, then listens for clients.
//! - Each client is expected to send:
//!
//!     + One single command (with optional arguments).
//!     + Its credentials: process ID, user ID, group ID.
//!     + Its standard streams: input, output, error.
//!     + Its current working directory and environment variables.
//!
//! The command will be run by server under client's credentials, with standard streams routed to client's. The new process ID will be sent
//! back to client. So when the user uses Ctrl-C, client can *forward* it to that process ID.
//!
//! The idea is to group client processes under one single process: the server. This helps with resource management.
//!
//! ## Notes
//!
//! - Nightly Rust is required.
//!
//! - Due to technical requirements, currently only Linux is supported. Because:
//!
//!     + Linux supports abstract sockets.
//!     + Linux supports sending credentials between processes, via Unix domain socket. Some BSD systems also support this feature, but
//!       implementation details differ -- and currently this project only supports Linux's implementation.
//!
//!     For details, see `unix(7)`.
//!
//! [Semantic Versioning 2.0.0]: https://semver.org/spec/v2.0.0.html

#![warn(missing_docs)]
#![cfg(any(target_os = "linux", target_os = "l4re"))]

// ╔═════════════════╗
// ║   IDENTIFIERS   ║
// ╚═════════════════╝

macro_rules! code_name  { () => { "r50" }}
macro_rules! version    { () => { "0.18.2" }}

/// # Crate name
pub const NAME: &str = "R50";

/// # Crate code name
pub const CODE_NAME: &str = code_name!();

/// # ID of this crate
pub const ID: &str = concat!(
    "98178d52-766c26f2-76cdae3f-95c0bc79-6baef9dc-7e754cb8-bd3e8a6f-fa4f119d-",
    "7e6a00f1-e4f881d0-260a988d-5bf8eb58-b4e49fc0-74cfb1fc-4f4b2671-12d89845",
);

/// # Crate version
pub const VERSION: &str = version!();

/// # Crate release date (year/month/day)
pub const RELEASE_DATE: (u16, u8, u8) = (2023, 2, 5);

/// # Tag, which can be used for logging...
pub const TAG: &str = concat!(code_name!(), "::98178d52::", version!());

// ╔════════════════════╗
// ║   IMPLEMENTATION   ║
// ╚════════════════════╝

pub mod version_info;

#[test]
fn test_crate_version() {
    assert_eq!(VERSION, env!("CARGO_PKG_VERSION"));
}

/// # Result type used in this crate
pub type Result<T> = std::io::Result<T>;