Struct Annotation 

pub struct Annotation {
    pub id: Option<String>,
    pub attributes: Vec<ForeignAttribute>,
    pub items: Vec<AnnotationItem>,
    pub source: Option<SourceRef>,
}

Annotation - contains appinfo and documentation elements

Annotations can appear on most schema elements and are used for:

• Human documentation
• Machine-readable extensions (JAXB, XBRL, etc.)

Fields

id: Option<String>

ID attribute

attributes: Vec<ForeignAttribute>

Foreign attributes on the annotation element itself

items: Vec<AnnotationItem>

Annotation items (appinfo and documentation in order)

source: Option<SourceRef>

Source location

Implementations

impl Annotation

pub fn new() -> Self

Create a new empty annotation

pub fn is_empty(&self) -> bool

Check if this annotation is empty

pub fn add_appinfo(&mut self, appinfo: AppInfoElement)

Add an appinfo element

pub fn add_documentation(&mut self, doc: DocumentationElement)

Add a documentation element

pub fn appinfos(&self) -> impl Iterator<Item = &AppInfoElement>

Get all appinfo elements

pub fn documentations(&self) -> impl Iterator<Item = &DocumentationElement>

Get all documentation elements

pub fn documentation_for_lang( &self, lang: &str, ) -> Option<&DocumentationElement>

Get documentation in a specific language

pub fn add_foreign_attribute(&mut self, attr: ForeignAttribute)

Add a foreign attribute

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 Default for Annotation

fn default() -> Self

Returns the “default value” for a type.