Struct FileInformation 

pub struct FileInformation { /* private fields */ }

Efficient file content analysis for location lookups

This struct stores metadata about a file that enables fast conversion from byte offsets to (row, column) positions without storing the full file content.

Implementations

impl FileInformation

pub fn new(content: &str) -> Self

Create file information by analyzing content

Scans the content once to build an index of line break positions. This enables O(log n) offset-to-location lookups via binary search.

Example

use quarto_source_map::FileInformation;

let info = FileInformation::new("line 1\nline 2\nline 3");

pub fn from_parts(line_breaks: Vec<usize>, total_length: usize) -> Self

Create file information from pre-computed parts

This is useful when deserializing from formats that store line break information directly (like JSON).

Example

use quarto_source_map::FileInformation;

let info = FileInformation::from_parts(vec![6, 13], 20);

pub fn offset_to_location( &self, offset: usize, content: &str, ) -> Option<Location>

Convert a byte offset to a Location with row and column

Uses binary search to find which line contains the offset. Runs in O(log n) time where n is the number of lines.

The column is computed as character count (not byte count) from the start of the line to the offset, which requires the content parameter.

Returns None if the offset is out of bounds.

Example

use quarto_source_map::FileInformation;

let content = "hello\nworld";
let info = FileInformation::new(content);
let loc = info.offset_to_location(6, content).unwrap();
assert_eq!(loc.row, 1);
assert_eq!(loc.column, 0);

pub fn total_length(&self) -> usize

Get the total length of the file in bytes

pub fn line_breaks(&self) -> &[usize]

Get the line breaks array (byte offsets of newline characters)

pub fn line_count(&self) -> usize

Get the number of lines in the file

Trait Implementations

impl Clone for FileInformation

fn clone(&self) -> FileInformation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileInformation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileInformation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FileInformation

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FileInformation