Struct EnhancedDocumentation 

pub struct EnhancedDocumentation {
    pub text: String,
    pub validation: FieldValidation,
    pub tags: Vec<DocTag>,
    pub span: Span,
}

Enhanced documentation with embedded validation directives.

Fields

text: String

The main documentation text (cleaned of validation directives).

validation: FieldValidation

Parsed validation rules from documentation.

tags: Vec<DocTag>

Additional metadata tags.

span: Span

Source location.

Implementations

impl EnhancedDocumentation

pub fn new(text: impl Into<String>, span: Span) -> EnhancedDocumentation

Create new enhanced documentation.

pub fn parse(raw_text: &str, span: Span) -> EnhancedDocumentation

Parse documentation text and extract validation rules.

pub fn has_validation(&self) -> bool

Check if this documentation has any validation rules.

pub fn validation_rules(&self) -> &[ValidationRule]

Get all validation rules.

pub fn get_tag(&self, name: &str) -> Option<&DocTag>

Get a specific tag by name.

pub fn get_tags(&self, name: &str) -> Vec<&DocTag>

Get all tags with a specific name.

pub fn has_tag(&self, name: &str) -> bool

Check if a specific tag exists.

pub fn extract_metadata(&self) -> FieldMetadata

Extract field metadata from documentation tags.

pub fn is_hidden(&self) -> bool

Check if field is marked as hidden.

pub fn is_deprecated(&self) -> bool

Check if field is marked as deprecated.

pub fn deprecation_info(&self) -> Option<DeprecationInfo>

Get deprecation info if deprecated.

pub fn is_sensitive(&self) -> bool

Check if field is marked as sensitive.

pub fn is_readonly(&self) -> bool

Check if field is marked as readonly.

pub fn is_writeonly(&self) -> bool

Check if field is marked as writeonly.

pub fn examples(&self) -> Vec<&str>

Get examples from documentation.

pub fn label(&self) -> Option<&str>

Get the display label.

pub fn placeholder(&self) -> Option<&str>

Get the placeholder text.

pub fn since(&self) -> Option<&str>

Get the version since this field was introduced.

pub fn group(&self) -> Option<&str>

Get the field group for UI organization.

Trait Implementations

impl Clone for EnhancedDocumentation

fn clone(&self) -> EnhancedDocumentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnhancedDocumentation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EnhancedDocumentation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EnhancedDocumentation

fn eq(&self, other: &EnhancedDocumentation) -> 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 EnhancedDocumentation

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 StructuralPartialEq for EnhancedDocumentation