Struct Paragraph 

pub struct Paragraph {
    pub lines: Vec<ContentItem>,
    pub annotations: Vec<Annotation>,
    pub location: Range,
}

A paragraph represents a block of text lines

Fields

lines: Vec<ContentItem>

Lines stored as ContentItems (each a TextLine wrapping TextContent)

annotations: Vec<Annotation>

location: Range

Implementations

impl Paragraph

pub fn new(lines: Vec<ContentItem>) -> Self

pub fn from_line(line: String) -> Self

pub fn from_line_at(line: String, location: Range) -> Self

Create a paragraph with a single line and attach a location

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

Preferred builder

pub fn text(&self) -> String

pub fn annotations(&self) -> &[Annotation]

Annotations attached to this paragraph.

pub fn annotations_mut(&mut self) -> &mut Vec<Annotation>

Mutable access to paragraph annotations.

pub fn iter_annotations(&self) -> Iter<'_, Annotation>

Iterate over annotation blocks in source order.

pub fn iter_annotation_contents(&self) -> impl Iterator<Item = &ContentItem>

Iterate over all content items nested inside attached annotations.

Trait Implementations

impl AstNode for Paragraph

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 Paragraph

fn clone(&self) -> Paragraph

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Paragraph

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

Formats the value using the given formatter.

impl Display for Paragraph

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

Formats the value using the given formatter.

impl PartialEq for Paragraph

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

fn text(&self) -> String

fn lines(&self) -> &[TextContent]

impl VisualStructure for Paragraph

fn collapses_with_children(&self) -> bool

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

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

impl StructuralPartialEq for Paragraph