scsys

Warning: the library is currently in development so be prepared for major modifications to the API!

Welcome to scsys, a collection of useful utilities, types, and other primitives that are used in various projects developed by Scattered Systems. The library is designed to be a general-purpose utility library that can be used in any Rust project, aiming to provide a standardized set of tools that can be used to build robust and reliable software.

Getting Started

Building from the source

Make sure you have the latest version of the Rust toolchain installed on your system.

rustup update

Clone the repository

git clone https://github.com/scattered-systems/scsys.git

then, navigate to the project directory

cd scsys

Building Locally

cargo build --all-features -v --workspace

Testing

Automatically format and analyze the codebase before building then testing.

cargo test --all-features -r -v --workspace

Usage

Add the dependency to your project

[dependencies.scsys]
features = ["full"]
version = "0.2.*"

Examples

Example: Using the Message type

use scsys::prelude::*;

fn main() {
  println!("{:?}", Message::<String>::default());
}

License

Licensed under the Apache License, Version 2.0, (LICENSE-APACHE)

Contribution

Contributions are welcome, however, ensure that you have read the CONTRIBUTING.md file before submitting a pull request.