Example guideline with bibliography (gui_Bib7x9KmPq2nL)

Guideline: Example guideline with bibliography gui_Bib7x9KmPq2nL

status: draft

tags: safety, undefined-behavior

category: advisory

fls: fls_69zyas59o8ff

decidability: decidable

scope: module

release: 1.0.0-latest

child needs: rat_Bib7x9KmPq2nL, non_compl_ex_Bib7x9KmPq2nL, compl_ex_Bib7x9KmPq2nL, bib_Bib7x9KmPq2nL

This is an example guideline demonstrating the bibliography feature.

As documented in [RUST-REF-UNION], union types in Rust have specific safety requirements. The CERT C Coding Standard [CERT-C-INT34] provides guidance on avoiding undefined behavior in shift operations, which applies to Rust as well.

Rationale: rat_Bib7x9KmPq2nL

status: draft

parent needs: gui_Bib7x9KmPq2nL

This guideline demonstrates how to include bibliographic references in coding guidelines. References help users find authoritative sources for the recommendations made.

Refer to [RUST-REF-UNION] for more details.

Non-Compliant Example: non_compl_ex_Bib7x9KmPq2nL

status: draft

parent needs: gui_Bib7x9KmPq2nL

This example shows code that violates the guideline.

fn main() {
    // Non-compliant code example
    let x = 42;
    println!("{}", x);
}

Compliant Example: compl_ex_Bib7x9KmPq2nL

status: draft

parent needs: gui_Bib7x9KmPq2nL

This example shows the correct way to follow the guideline.

fn main() {
    // Compliant code example
    let x: i32 = 42;
    println!("{}", x);
}

Bibliography: bib_Bib7x9KmPq2nL

status: draft

parent needs: gui_Bib7x9KmPq2nL

[RUST-REF-UNION]↩	The Rust Reference. “Unions.” https://doc.rust-lang.org/reference/items/unions.html
[CERT-C-INT34]↩	SEI CERT C Coding Standard. “INT34-C. Do not shift an expression by a negative number of bits.” https://wiki.sei.cmu.edu/confluence/x/ItcxBQ