Crate api_guidelines 

API Guidelines

A Rust library providing structured enums and utilities for the official Rust API Guidelines.

This crate implements the Rust API Guidelines as structured enums, making it easier to:

• Reference specific guidelines in code
• Build linting tools
• Document API design decisions
• Ensure code quality and consistency

Example

use api_guidelines::{Naming, Interoperability};

// Reference naming conventions
let naming_convention = Naming::C_CASE;
let conversion_guideline = Naming::C_CONV;

// Reference interoperability guidelines
let common_traits = Interoperability::C_COMMON_TRAITS;
let conversion_traits = Interoperability::C_CONV_TRAITS;

Based on the official Rust API Guidelines.

Enums

Debuggability

Dependability

Documentation

Flexibility

FutureProofing

Interoperability

Macro

Naming

Naming conventions and guidelines for Rust APIs

Necessities

Predictability

TypeSafety