Struct CodingStandards 

pub struct CodingStandards {
    pub edition: EditionStandards,
    pub file_limits: FileLimits,
    pub function_limits: FunctionLimits,
    pub documentation: DocumentationStandards,
    pub banned_patterns: BannedPatterns,
    pub dependencies: DependencyStandards,
    pub security: SecurityStandards,
}

Rust coding standards enforced by Ferrous Forge

Fields

edition: EditionStandards

Rust edition requirements

file_limits: FileLimits

File size limits

function_limits: FunctionLimits

Function size limits

documentation: DocumentationStandards

Documentation requirements

banned_patterns: BannedPatterns

Banned patterns and practices

dependencies: DependencyStandards

Dependency requirements

security: SecurityStandards

Security requirements

Implementations

impl CodingStandards

pub fn load() -> Result<Self>

Load standards from configuration

pub fn save(&self) -> Result<()>

Save standards to configuration

pub fn get_clippy_rules(&self) -> Vec<String>

Get all clippy rules based on these standards

pub fn generate_clippy_config(&self) -> String

Generate clippy.toml configuration

pub async fn check_compliance(&self, project_path: &Path) -> Result<Vec<String>>

Check if a project complies with these standards

Trait Implementations

impl Clone for CodingStandards

fn clone(&self) -> CodingStandards

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CodingStandards

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CodingStandards

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CodingStandards

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CodingStandards

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.