Struct AuditIssue 

pub struct AuditIssue {
    pub id: String,
    pub file_path: PathBuf,
    pub line_number: Option<usize>,
    pub column_number: Option<usize>,
    pub severity: IssueSeverity,
    pub category: IssueCategory,
    pub message: String,
    pub suggestion: Option<String>,
    pub context: Option<String>,
    pub code_snippet: Option<String>,
    pub related_issues: Vec<String>,
}

Available on crate feature doc-audit only.

A specific issue found during documentation audit.

Fields

id: String

Unique identifier for this issue

file_path: PathBuf

Path to the file containing the issue

line_number: Option<usize>

Line number where the issue occurs (if applicable)

column_number: Option<usize>

Column number where the issue occurs (if applicable)

severity: IssueSeverity

Severity level of the issue

category: IssueCategory

Category of the issue

message: String

Human-readable description of the issue

suggestion: Option<String>

Suggested fix for the issue (if available)

context: Option<String>

Additional context or details

code_snippet: Option<String>

Code snippet showing the problematic area

related_issues: Vec<String>

Related issues (by ID)

Implementations

impl AuditIssue

pub fn new( file_path: PathBuf, category: IssueCategory, message: String, ) -> AuditIssue

Create a new audit issue with the given parameters.

pub fn with_line_number(self, line_number: usize) -> AuditIssue

Set the line number for this issue.

pub fn with_column_number(self, column_number: usize) -> AuditIssue

Set the column number for this issue.

pub fn with_severity(self, severity: IssueSeverity) -> AuditIssue

Set the severity for this issue.

pub fn with_suggestion(self, suggestion: String) -> AuditIssue

Set a suggestion for fixing this issue.

pub fn with_context(self, context: String) -> AuditIssue

Set additional context for this issue.

pub fn with_code_snippet(self, code_snippet: String) -> AuditIssue

Set a code snippet showing the problematic area.

pub fn with_related_issue(self, issue_id: String) -> AuditIssue

Add a related issue ID.

Trait Implementations

impl Clone for AuditIssue

fn clone(&self) -> AuditIssue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuditIssue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuditIssue

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AuditIssue

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.