Struct VLineInfo 

#[non_exhaustive]
pub struct VLineInfo<L = VLine> {
    pub interval: Interval,
    pub line_count: usize,
    pub rvline: RVLine,
    pub vline: L,
}

Information about the visual line and how it relates to the underlying buffer line.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

interval: Interval

Start offset to end offset in the buffer that this visual line covers.

Note that this is obviously not including phantom text.

line_count: usize

The total number of lines in this buffer line. Always at least 1.

rvline: RVLine

vline: L

The actual visual line this is for.

For relative visual line iteration, this is empty.

Implementations

impl<L: Debug> VLineInfo<L>

pub fn new<I: Into<Interval>>( iv: I, rvline: RVLine, line_count: usize, vline: L, ) -> Self

Create a new instance of VLineInfo

This should rarely be used directly.

pub fn to_blank(&self) -> VLineInfo<()>

pub fn is_empty(&self) -> bool

Check whether the interval is empty.

Note that there could still be phantom text on this line.

pub fn is_empty_phantom(&self) -> bool

Check whether the interval is empty and we’re not on the first line, thus likely being phantom text (or possibly poor wrapping)

pub fn is_first(&self) -> bool

pub fn is_last(&self, text_prov: &impl TextLayoutProvider) -> bool

Is this the last visual line for the relevant buffer line?

pub fn first_col(&self, text_prov: &impl TextLayoutProvider) -> usize

Get the first column of the overall line of the visual line

pub fn last_col( &self, text_prov: &impl TextLayoutProvider, caret: bool, ) -> usize

Get the last column in the overall line of this visual line

The caret decides whether it is after the last character, or before it.

// line content = "conf = Config::default();\n"
// wrapped breakup = ["conf = ", "Config::default();\n"]

// when vline_info is for "conf = "
assert_eq!(vline_info.last_col(text_prov, false), 6) // "conf =| "
assert_eq!(vline_info.last_col(text_prov, true), 7) // "conf = |"
// when vline_info is for "Config::default();\n"
// Notice that the column is in the overall line, not the wrapped line.
assert_eq!(vline_info.last_col(text_prov, false), 24) // "Config::default()|;"
assert_eq!(vline_info.last_col(text_prov, true), 25) // "Config::default();|"

pub fn line_end_offset( &self, text_prov: &impl TextLayoutProvider, caret: bool, ) -> usize

pub fn first_non_blank_character( &self, text_prov: &impl TextLayoutProvider, ) -> usize

Returns the offset of the first non-blank character in the line.

Trait Implementations

impl<L: Clone> Clone for VLineInfo<L>

fn clone(&self) -> VLineInfo<L>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<L: Debug> Debug for VLineInfo<L>

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

Formats the value using the given formatter.

impl<L: PartialEq> PartialEq for VLineInfo<L>

fn eq(&self, other: &VLineInfo<L>) -> 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<L: Copy> Copy for VLineInfo<L>

impl<L: Eq> Eq for VLineInfo<L>

impl<L> StructuralPartialEq for VLineInfo<L>