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

// License: see LICENSE file at root directory of `master` branch

//! # Bailamos
//!
//! ## Project
//!
//! - Repository: <https://bitbucket.org/haibison/bailamos>
//! - License: Nice License 1.0.0 _(see LICENSE file at root directory of `master` branch)_
//! - _This project follows [Semantic Versioning 2.0.0]_
//!
//! ## Features
//!
//! This project provides:
//!
//! - A server program with basic manager for users and notifications.
//! - A client library for other projects to communicate with the server.
//!
//! A simple specification of remote procedure call will be made when the project reaches stable release. That could help projects in other
//! languages.
//!
//! Please note that this project strictly follows [Semantic Versioning 2.0.0]. In early development state, it's expected to be changed
//! frequently. So currently it's not recommended to use the project in production.
//!
//! ## Server
//!
//! Server is available via `server` feature. You can pass `help` command to the program to view detailed documentation.
//!
//! ## Client
//!
//! Please refer to [`rpc`][::rpc].
//!
//! # Failures
//!
//! Panics, missing documentation, missing tests... are my failures. It would help me a lot if you file new issues when you encounter such
//! problems.
//!
//! Thank you,
//!
//! [Semantic Versioning 2.0.0]: https://semver.org/spec/v2.0.0.html
//! [::rpc]: rpc/index.html

#![warn(missing_docs)]

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

macro_rules! code_name  { () => { "bailamos" }}
macro_rules! version    { () => { "0.9.1" }}

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

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

/// # ID of this crate
pub const ID: &str = concat!(
    "9a8f6277-c826c781-adb4e4be-72672692-cbc02779-c5610554-3c546676-772900ae-",
    "57519250-a76bd747-e74d9f5c-38e87af5-cf2a35e5-cb6f9aa9-40b1ae26-3dff4a48",
);

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

/// # Crate release date (year/month/day)
pub const RELEASE_DATE: (u16, u8, u8) = (2019, 8, 16);

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

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

pub mod db;
pub mod rpc;
pub mod version_info;

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

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

/// # Certificate, in PKCS #12 format
pub const CERT_P12: &[u8] = include_bytes!("../res/certs/cert.p12");

/// # Certificate's passphrase
pub const CERT_P12_PASSPHRASE: &str = include_str!("../res/certs/cert.p12.passphrase");

#[test]
fn test_cert() {
    assert_eq!(CERT_P12_PASSPHRASE, CERT_P12_PASSPHRASE.trim());
}