Struct ParagraphMetricsMetadata

pub struct ParagraphMetricsMetadata {
    pub paragraph_count: usize,
    pub dirty_range: Option<Range<usize>>,
    pub local_version: u64,
    pub total_height: f32,
    pub max_width: f32,
    /* private fields */
}

Aggregate metadata from the most recent layout pass.

A first pass has no prior revision set and therefore reports dirty_range == None. Later changes use a half-open paragraph-index range; a changed paragraph count marks 0..paragraph_count dirty.

Examples

use ailloli_ui_core::Rect;
use ailloli_ui_editor::{layout::{build_visible_text_layout, LayoutCache, ParagraphMetricsCache}, EditorConfig, EditorStyle, EditorViewport};
use ailloli_ui_text::{TextBuffer, TextEditState, TextSystem};
let buffer = TextBuffer::from_string("a\nb");
let viewport = EditorViewport::new(Rect::new(0.0, 0.0, 100.0, 60.0), EditorConfig::default(), &TextEditState::new());
let (mut layouts, mut metrics, mut text_system) = (LayoutCache::default(), ParagraphMetricsCache::default(), TextSystem::new());
build_visible_text_layout(&buffer, viewport, EditorStyle::default(), &mut layouts, &mut metrics, &mut text_system);
assert_eq!(metrics.metadata().unwrap().paragraph_count, 2);

Fields

paragraph_count: usize

Number of logical paragraphs observed in the last pass.

dirty_range: Option<Range<usize>>

Smallest half-open range whose stored revisions changed, if any.

local_version: u64

Maximum paragraph revision, or zero for no paragraphs.

total_height: f32

Sum of visible paragraph heights in logical pixels.

max_width: f32

Maximum visible paragraph width in logical pixels.

Trait Implementations

impl Clone for ParagraphMetricsMetadata

fn clone(&self) -> ParagraphMetricsMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParagraphMetricsMetadata

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

Formats the value using the given formatter.

impl PartialEq for ParagraphMetricsMetadata

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