FST Network Rust Common Libraries

Crates in this Repository

• k8s-structural-schema Kubernetes structural schema utilities for schemars
• lifecycle-manager a utility for spawning background workers and handling UNIX signals
• pulsar-client Apache Pulsar client library for Rust based on libpulsar
• pulsar-client-sys Native bindings to the libpulsar

Development

• .github contains GitHub Actions related definition.
• dev-support contains development utilities
  • dev-support/bin contains tools which will be used through development process
  • dev-support/nix-overlay contains overrides to Nix channel or custom derivations

Git Hooks

It is suggested to install git hook for style linting before code committing. This project is configured with pre-commit.

Installation steps:

pre-commit install --install-hooks -t commit-msg -t pre-commit

Tools

There are some useful commands just like the one in Rust toolchain but with proper arguments:

• cargo build-all
• cargo clippy-all
• cargo test-all
• cargo doc-all
• cargo miri-all
• cargo watch-all (ex. cargo watch-all clippy)

Please perform the following steps before submitting Pull Request:

It is suggested to perform the following steps before submitting Pull Request:

• Run codespell to find out common misspellings
• Run format-check to check format of Rust, Shell, Nix, JavaScript, TypeScript, Markdown, JSON, YAML
• Run cargo clippy-all to lint common mistakes of Rust
• Run cargo test-all to perform tests
• Run udeps to check unused dependencies

Other tools:

• install-deps: Install dependencies
• format-all: format all files
• format-rust: format *.rs files
• lines-of-code: Count lines of code in this project