Enum IssueCategory 

pub enum IssueCategory {
    ApiMismatch,
    VersionInconsistency,
    CompilationError,
    BrokenLink,
    MissingDocumentation,
    DeprecatedApi,
    InvalidImport,
    ConfigurationError,
    AsyncPatternError,
    InvalidFeatureFlag,
    InvalidCrateName,
    QualityIssue,
    ProcessingError,
    ValidationError,
}

Available on crate feature doc-audit only.

Categories of issues that can be found during audit.

Variants

ApiMismatch

API reference doesn’t match actual implementation

VersionInconsistency

Version numbers are inconsistent or outdated

CompilationError

Code example fails to compile

BrokenLink

Internal link is broken or incorrect

MissingDocumentation

Feature exists but is not documented

DeprecatedApi

Documentation references deprecated API

InvalidImport

Import statement is invalid or incorrect

ConfigurationError

Configuration parameter is wrong or missing

AsyncPatternError

Async/await pattern is incorrect

InvalidFeatureFlag

Feature flag reference is invalid

InvalidCrateName

Crate name reference is invalid

QualityIssue

General documentation quality issue

ProcessingError

Error occurred while processing the file

ValidationError

Error occurred during validation

Implementations

impl IssueCategory

pub fn description(&self) -> &'static str

Get a human-readable description of the issue category.

pub fn default_severity(&self) -> IssueSeverity

Get the default severity for this category.

Trait Implementations

impl Clone for IssueCategory

fn clone(&self) -> IssueCategory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IssueCategory

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IssueCategory

fn deserialize<__D>( __deserializer: __D, ) -> Result<IssueCategory, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for IssueCategory

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for IssueCategory

fn eq(&self, other: &IssueCategory) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for IssueCategory

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for IssueCategory

impl Eq for IssueCategory

impl StructuralPartialEq for IssueCategory