Skip to main content

Injection

Struct Injection 

Source
pub struct Injection {
    pub language_id: String,
    pub ranges: Vec<Range<usize>>,
    pub start_row: u32,
    pub start_col: u32,
    pub end_row: u32,
    pub end_col: u32,
}
Expand description

An injection point for embedded languages.

Injections allow one language to be embedded within another, such as code blocks in markdown or script tags in HTML.

§Single vs Combined Injections

  • Single-range: A fenced code block in Markdown produces one injection with one byte range (e.g., the code block content).
  • Combined: Consecutive doc comment lines (///) produce one injection with multiple byte ranges (one per comment line), merged via #set! injection.combined.

§Example

use reovim_driver_syntax::Injection;

// A Rust code block in a markdown file
let inj = Injection::new("rust", 100..200, 5, 3, 10, 3);
assert_eq!(inj.language_id, "rust");
assert!(inj.overlaps_lines(6, 8));

Fields§

§language_id: String

The language ID to use for the injected region.

§ranges: Vec<Range<usize>>

Byte ranges in the parent document. Single-range injections (fenced code blocks) have exactly one element. Combined injections (doc comment lines) have multiple elements.

§start_row: u32

Start row (0-indexed) of the first range.

§start_col: u32

Start column (0-indexed) of the first range.

§end_row: u32

End row (0-indexed) of the last range.

§end_col: u32

End column (0-indexed) of the last range.

Implementations§

Source§

impl Injection

Source

pub fn new( language_id: impl Into<String>, byte_range: Range<usize>, start_row: u32, start_col: u32, end_row: u32, end_col: u32, ) -> Self

Create a new single-range injection.

Source

pub fn combined( language_id: impl Into<String>, ranges: Vec<Range<usize>>, start_row: u32, start_col: u32, end_row: u32, end_col: u32, ) -> Self

Create a combined injection from multiple byte ranges.

Used for injection.combined patterns where multiple source nodes (e.g., consecutive doc comment lines) map to a single injection.

Source

pub fn from_bytes( language_id: impl Into<String>, byte_range: Range<usize>, ) -> Self

Create an injection from byte range only (row/col set to 0).

Useful when only byte positions are known.

Source

pub fn byte_range(&self) -> Range<usize>

Get the overall byte range (start of first range to end of last range).

For single-range injections, this is identical to the original range. For combined injections, this spans the entire region.

Source

pub const fn overlaps_lines(&self, start_line: u32, end_line: u32) -> bool

Check if this injection overlaps with a line range.

Both start_line and end_line are inclusive.

Source

pub const fn contains_line(&self, line: u32) -> bool

Check if this injection contains a specific line.

Source

pub fn overlaps_bytes(&self, range: &Range<usize>) -> bool

Check if this injection overlaps with a byte range.

Source

pub fn byte_len(&self) -> usize

Get the total number of bytes across all ranges.

Source

pub const fn is_multiline(&self) -> bool

Check if this injection spans multiple lines.

Source

pub const fn line_count(&self) -> u32

Get the number of lines spanned by this injection.

Source

pub const fn is_combined(&self) -> bool

Check if this is a combined injection (multiple ranges).

Trait Implementations§

Source§

impl Clone for Injection

Source§

fn clone(&self) -> Injection

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Injection

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Injection

Source§

fn eq(&self, other: &Injection) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Injection

Source§

impl StructuralPartialEq for Injection

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more