Struct DocumentTitle 

pub struct DocumentTitle {
    pub content: TextContent,
    pub subtitle: Option<TextContent>,
    pub location: Range,
}

A first-class document title element.

Represents the title of a Lex document — a single unindented line at the start of the document, followed by blank lines, with no indented content after. This is distinct from session titles.

An optional subtitle is supported: when the title line ends with a colon and a second non-blank, non-indented line follows before the blank separator, the second line is parsed as a subtitle. The trailing colon is structural (stripped from the title content).

Fields

content: TextContent

subtitle: Option<TextContent>

location: Range

Implementations

impl DocumentTitle

pub fn new(content: TextContent, location: Range) -> Self

pub fn with_subtitle( content: TextContent, subtitle: TextContent, location: Range, ) -> Self

pub fn from_string(text: String, location: Range) -> Self

pub fn as_str(&self) -> &str

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

Trait Implementations

impl AstNode for DocumentTitle

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 DocumentTitle

fn clone(&self) -> DocumentTitle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentTitle

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

Formats the value using the given formatter.

impl PartialEq for DocumentTitle

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