Crate ruc

Source
Expand description

GitHub top language Rust Latest Version Rust Documentation Minimum rustc version

§ruc

Rust Util Collection, components included:

  • Chained error management
  • Local command execution based on rust standard library
    • required features: cmd
  • Remote command execution based on the SSH protocol
    • required features: ssh
  • Interprocess Communication Based on Unix Abstract Sockets
    • required features: uau
    • only available on various Linux platforms
    • the built-in functions only support the UDP protocol
  • Algorithm operations
    • required features: algo
      • rand, hash, ecc sigature, etc.
  • Encode/Decode operations
    • required features: ende
      • hex, base64
      • zlib compress, zlib uncompress
      • json, message-pack, serde transcode
      • and so on …

In addition, there is a feature named “full”, using it will enable all functional features.

§Documentations

# cargo doc --all-features --open
make doc

Links to static documentations:

§ENV VARs
  • $RUC_SSH_TIMEOUT: ssh process timeout
    • Default to 20s
    • The max value is 300s(5 minutes)
  • $RUC_HTTP_TIMEOUT: http process timeout
    • Default to 3s
    • The max value is 255s(u8::MAX)

§Gratitude

Thanks to all the people who already contributed!

Re-exports§

pub use err::*;

Modules§

algo
cmd
cmd
common
Common
ende
err
Error management
http
ssh
SSH
uau
UAU

Macros§

alt
optimize readable in high-level-functions
d
print debug-info, eg: modular and file path, line number …
datetime
get current DateTime
die
Just a panic
eg
Generate error with debug info
eprint_msg
eprint custom msg
info
print infomation only
info_omit
drop the result afeter printing the message
map
HashMap/BTreeMap operations
max
find the max value of multi values
min
find the min value of multi values
omit
omit the result without printing any message
pnk
Print log, and panic
print_msg
print custom msg
set
HashSet/BTreeSet operations
sleep_ms
Sleep in milliseconds
ts
get current UTC-timestamp