Struct Annotation 

pub struct Annotation {
    pub path: String,
    pub title: Option<String>,
    pub description: Option<String>,
}

Annotation data extracted from a JSON Schema property

Fields

path: String

Dot-separated path (e.g., “server.port”)

title: Option<String>

Schema title field

description: Option<String>

Schema description field

Implementations

impl Annotation

pub fn new(path: impl Into<String>) -> Self

Create a new annotation

pub fn with_title(self, title: impl Into<String>) -> Self

Set the title

pub fn with_description(self, description: impl Into<String>) -> Self

Set the description

pub fn to_comment_lines(&self, max_width: Option<usize>) -> Vec<String>

Format as comment lines

pub fn is_empty(&self) -> bool

Check if this annotation has any content

Trait Implementations

impl Clone for Annotation

fn clone(&self) -> Annotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Annotation

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

Formats the value using the given formatter.

impl PartialEq for Annotation

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

impl StructuralPartialEq for Annotation