Rust style guidelines

Run clippy before submitting a PR for reviewing

Clippy is a nice tool to check common pitfalls and anti-patterns. Its lints get often turned into lints of the compiler.

cargo clippy --no-deps --workspace --exclude kraken-sdk 

Formatting with rustfmt

rustfmt is used to format the complete rust codebase and only on weird formatting cases, the #[rustfmt::skip] annotation should be used.

Run rustfmt with the following parameters:

rustfmt --config imports_granularity="Item,group_imports=StdExternalCrate" $FILE

You can also run rustfmt on the whole project:

cargo +nightly fmt

Use and mod prevalence

Module declarations should always be declared after the use statements.

Do:

use std::fs::create_dir;

use uuid::Uuid;

mod bar;
mod foo;

Don't:

mod bar;
mod foo;

use std::fs::create_dir;

use uuid::Uuid;

Module-local imports / reexports

Use statements should either use the crate, super or self as top-level path-segments instead of implicit relative paths.

This is important as rustfmt would move the corresponding use statements in the "external crate" section.

Do:

use self::bar::*;

mod bar;

Don't:

use bar::*;

mod bar;

Avoid .into()

Use Y::from(x) instead of x.into()

Calling .into() on a value is tempting, especially when used in a chain of several calls. However, it can be quite difficult to follow what is converted into what.

Do:

let bar = Bar::from(foo);
let baz = Baz::try_from(bar)?;

Don't

let bar = foo.into();
let baz = bar.try_into();