Rust
Rust Style Guide

Einführung

Bemerkungen

cargo install clippy
cargo install rustfmt

cargo clippy
cargo fmt

Whitespace

Linienlänge

// Lines should never exceed 100 characters. 
// Instead, just wrap on to the next line.
let bad_example = "So this sort of code should never really happen, because it's really hard to fit on the screen!";

Vertiefung

// You should always use 4 spaces for indentation. 
// Tabs are discouraged - if you can, set your editor to convert
// a tab into 4 spaces.
let x = vec![1, 3, 5, 6, 7, 9];
for item in x {
    if x / 2 == 3 {
        println!("{}", x);
    }
}

Nachlaufender Whitespace

Nachgestellte Leerzeichen am Ende von Dateien oder Zeilen sollten gelöscht werden.

Binäre Operatoren

// For clarity, always add a space when using binary operators, e.g.
// +, -, =, *
let bad=3+4;
let good = 3 + 4;

Dies gilt auch für Attribute, zum Beispiel:

// Good:
#[deprecated = "Don't use my class - use Bar instead!"]

// Bad:
#[deprecated="This is broken"]

Semikolons

// There is no space between the end of a statement
// and a semicolon.

let bad = Some("don't do this!") ;
let good: Option<&str> = None;

Strukturfelder ausrichten

// Struct fields should **not** be aligned using spaces, like this:
pub struct Wrong {
    pub x  : i32,
    pub foo: i64 
}

// Instead, just leave 1 space after the colon and write the type, like this:
pub struct Right {
    pub x: i32,
    pub foo: i64
}

Funktionsunterschriften

// Long function signatures should be wrapped and aligned so that
// the starting parameter of each line is aligned
fn foo(example_item: Bar, another_long_example: Baz, 
       yet_another_parameter: Quux) 
       -> ReallyLongReturnItem {
    // Be careful to indent the inside block correctly!
}

Hosenträger

// The starting brace should always be on the same line as its parent.
// The ending brace should be on its own line.
fn bad()
{
    println!("This is incorrect.");
}

struct Good {
    example: i32
}

struct AlsoBad {
    example: i32 }

Kisten erstellen

Präludien und Reexporte

// To reduce the amount of imports that users need, you should
// re-export important structs and traits.
pub use foo::Client;
pub use bar::Server;

Manchmal verwenden Kisten ein prelude , das wichtige Strukturen enthält, genau wie std::io::prelude . Normalerweise werden diese mit use std::io::prelude::*; importiert use std::io::prelude::*;

Importe

Sie sollten Ihre Importe und Deklarationen so bestellen:

• extern crate
• use der Einfuhr
  • Externe Importe aus anderen Kisten sollten an erster Stelle stehen
• Reexporte ( pub use )

Benennung

Structs

// Structs use UpperCamelCase.
pub struct Snafucator {
    
}

mod snafucators {
    // Try to avoid 'stuttering' by repeating 
    // the module name in the struct name.

    // Bad:
    pub struct OrderedSnafucator {
    
    }
      
    // Good:
    pub struct Ordered {
        
    }
}

Züge

// Traits use the same naming principles as 
// structs (UpperCamelCase).
trait Read {
    fn read_to_snafucator(&self) -> Result<(), Error>;
}

Kisten und Module

// Modules and crates should both use snake_case.
// Crates should try to use single words if possible.
extern crate foo;
mod bar_baz {
    mod quux {

    }
}

Statische Variablen und Konstanten

// Statics and constants use SCREAMING_SNAKE_CASE.
const NAME: &'static str = "SCREAMING_SNAKE_CASE";

Aufzählungen

// Enum types and their variants **both** use UpperCamelCase.
pub enum Option<T> {
   Some(T),
   None
}

Funktionen und Methoden

// Functions and methods use snake_case
fn snake_cased_function() {

}

Variable Bindungen

// Regular variables also use snake_case
let foo_bar = "snafu";

Lebenszeiten

// Lifetimes should consist of a single lower case letter. By 
// convention, you should start at 'a, then 'b, etc.

// Good:
struct Foobar<'a> {
    x: &'a str
}

// Bad:
struct Bazquux<'stringlife> {
    my_str: &'stringlife str
}

Akronyme

Variablennamen, die Akronyme enthalten, wie z. B. TCP sollten folgendermaßen gestaltet werden:

• Bei UpperCamelCase Namen sollte der erste Buchstabe groß geschrieben werden (z. B. TcpClient )
• Für snake_case Namen sollte keine Großschreibung verwendet werden (zB tcp_client )
• Für SCREAMING_SNAKE_CASE Namen sollte das Akronym vollständig groß geschrieben werden (z. B. TCP_CLIENT )

Typen

Geben Sie Anmerkungen ein

// There should be one space after the colon of the type
// annotation. This rule applies in variable declarations,
// struct fields, functions and methods.

// GOOD:
let mut buffer: String = String::new();
// BAD:
let mut buffer:String = String::new();
let mut buffer : String = String::new();

Verweise

// The ampersand (&) of a reference should be 'touching'
// the type it refers to.

// GOOD:
let x: &str = "Hello, world.";
// BAD:
fn fooify(x: & str) {
    println!("{}", x);
}

// Mutable references should be formatted like so:
fn bar(buf: &mut String) {

}