algosul 0.0.5

Some user-friendly yet personalized tools
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

use std::{
  borrow::Cow,
  fmt::{Display, Formatter},
  path::{Path, PathBuf},
};

use serde::{Deserialize, Serialize};
use tokio::process::Command;

#[cfg(feature = "app-apps")]
pub mod apps;
/// application license
#[derive(
  Default,
  Debug,
  Clone,
  Eq,
  PartialEq,
  Hash,
  Ord,
  PartialOrd,
  Serialize,
  Deserialize,
)]
pub enum AppLicense
{
  #[default]
  Unknown,
  /// e.g. GPL-3.0-only
  Text(String),
  File(PathBuf),
  Or(Box<AppLicense>, Box<AppLicense>),
}
/// application information
pub trait AppInfo
{
  type Error;
  async fn name(&self) -> Cow<'_, str>;
  async fn license(&self) -> Result<Cow<'_, AppLicense>, Self::Error>;
  async fn readme(&self) -> Result<String, Self::Error>;
  async fn readme_md(&self) -> Result<String, Self::Error>;
  async fn documentation(&self) -> Result<Cow<'_, str>, Self::Error>;
  async fn homepage(&self) -> Result<Cow<'_, str>, Self::Error>;
  async fn repository(&self) -> Result<Cow<'_, str>, Self::Error>;
  async fn version(&self) -> Result<Cow<'_, str>, Self::Error>;
}
/// about the application paths
pub trait AppPath: AppInfo
{
  /// e.g. '~/.cargo/'
  async fn home_path(&self) -> Result<Cow<'_, Path>, Self::Error>;
  /// e.g. '~/.cargo/bin/rustup'
  async fn bin_path(&self) -> Result<Cow<'_, Path>, Self::Error>;
  async fn to_command(&self) -> Result<Command, Self::Error>
  {
    Ok(Command::new(self.bin_path().await?.as_ref()))
  }
}
/// application getter
pub trait AppGetter: Sized + AppPath
{
  async fn get_by_current_user() -> Result<Self, Self::Error>;
  async fn get_by_all_user() -> Result<Self, Self::Error>;
}
/// application operators
pub trait AppOper: Sized + AppInfo
{
  type Installer: crate::process::Process;
  type Reinstaller: crate::process::Process;
  type Remover: crate::process::Process;
  type Updater: crate::process::Process;
  async fn installer() -> Result<Self::Installer, Self::Error>;
  async fn reinstaller(self) -> Result<Self::Reinstaller, Self::Error>;
  async fn remover(self) -> Result<Self::Remover, Self::Error>;
  async fn updater(self) -> Result<Self::Updater, Self::Error>;
}
impl Display for AppLicense
{
  fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result
  {
    match self
    {
      AppLicense::Unknown => write!(f, "Unknown"),
      AppLicense::Text(s) => write!(f, "{s}"),
      AppLicense::Or(a, b) => write!(f, "{a} or {b}"),
      AppLicense::File(path) => write!(f, "{path:?}"),
    }
  }
}