Struct Annotation 

pub struct Annotation {
    pub data: Data,
    pub children: GeneralContainer,
    pub location: Range,
}

An annotation represents some metadata about an AST element.

Reserved label namespace

Labels starting with lex. (the lex.* namespace, Annotation::RESERVED_NAMESPACE_PREFIX) are reserved for core-defined semantics. Third-party tooling must not author labels in this namespace; the core may add new lex.* labels without a coordinating versioning concern. Non-reserved labels remain freely available for extensions (mycompany.include, docs.embed, etc.).

The current set of reserved labels:

• Annotation::INCLUDE_LABEL ("lex.include") — see comms/specs/proposals/includes.lex.

Fields

data: Data

children: GeneralContainer

location: Range

Implementations

impl Annotation

pub const RESERVED_NAMESPACE_PREFIX: &'static str = "lex."

Reserved label prefix for core-defined annotation semantics.

Any annotation whose label starts with this prefix is owned by the Lex core and may carry behavior in the resolver / analysis layers. External authors should pick a different namespace.

pub const INCLUDE_LABEL: &'static str = "lex.include"

Reserved label for the include directive.

An annotation with this label and a src= parameter is interpreted by lex_core::includes as a request to splice another Lex file’s content into the parent container at the annotation’s position. See comms/specs/proposals/includes.lex for the full design.

pub fn new( label: Label, parameters: Vec<Parameter>, children: Vec<ContentElement>, ) -> Self

pub fn marker(label: Label) -> Self

pub fn with_parameters(label: Label, parameters: Vec<Parameter>) -> Self

pub fn from_data(data: Data, children: Vec<ContentElement>) -> Self

pub fn at(self, location: Range) -> Self

Preferred builder

pub fn header_location(&self) -> &Range

Range covering only the annotation header (label + parameters).

pub fn body_location(&self) -> Option<Range>

Bounding range covering only the annotation’s children.

pub fn is_reserved(&self) -> bool

Whether this annotation’s label is in the reserved lex.* namespace.

pub fn is_include(&self) -> bool

Whether this annotation is the include directive (label lex.include).

Hides the string-match on the reserved label so callers don’t sprinkle annotation.label == "lex.include" throughout the codebase. Also serves as the migration boundary if a future version models includes as a distinct AST node type.

pub fn include_src(&self) -> Option<String>

The src= parameter value with surrounding quotes stripped and escape sequences resolved, if present.

Useful on its own for any annotation that uses a src parameter (verbatim-via-annotation, future lex.* directives, etc.). For the include-specific case, callers typically pair this with Annotation::is_include.

Returns an owned String rather than &str because escape resolution may need to allocate. For quote-free values (the common case) the returned string is the same as parameter.value minus the leading/trailing ".

Trait Implementations

impl AstNode for Annotation

fn node_type(&self) -> &'static str

fn display_label(&self) -> String

fn range(&self) -> &Range

fn accept(&self, visitor: &mut dyn Visitor)

Accept a visitor for traversing this node and its children

fn start_position(&self) -> Position

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

fn label(&self) -> &str

fn children(&self) -> &[ContentItem]

fn children_mut(&mut self) -> &mut Vec<ContentItem>

impl Debug for Annotation

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

Formats the value using the given formatter.

impl Display 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 StructuralPartialEq for Annotation

impl VisualStructure for Annotation

fn is_source_line_node(&self) -> bool

Whether this node corresponds to a line in the source document

fn has_visual_header(&self) -> bool

Whether this node has a visual header line separate from its content

fn collapses_with_children(&self) -> bool

Whether this is a homogeneous container whose children can collapse with parent icon