Struct File

pub struct File {
    pub id: FileId,
    pub name: String,
    pub path: Option<PathBuf>,
    pub file_type: FileType,
    pub contents: String,
    pub size: usize,
    pub lines: Vec<usize>,
}

A file that’s either stored on the host system’s file system or in the vendored file system.

This struct encapsulates all the necessary information about a file, including its content, location, and metadata for change detection.

Fields

id: FileId

A stable, unique identifier for the file, generated from its logical name. This ID persists across application runs and content modifications.

name: String

The logical name of the file, typically the path relative to the root of the project.

path: Option<PathBuf>

The absolute path of the file on the host’s filesystem, if it exists there. This will be None for vendored files that don’t have a physical counterpart.

file_type: FileType

The type of the file, indicating its origin.

contents: String

The contents of the file, if available.

size: usize

The size of the file’s contents in bytes.

lines: Vec<usize>

A vector containing the starting byte offsets of each line in contents. The first line always starts at offset 0. This is useful for quickly navigating to a specific line number without scanning the whole file.

Implementations

impl File

pub fn new( name: String, file_type: FileType, path: Option<PathBuf>, contents: String, ) -> Self

Creates a new File instance from its name, type, path, and contents.

It automatically calculates the size, and line start offsets.

pub fn read( workspace: &Path, path: &Path, file_type: FileType, ) -> Result<Self, DatabaseError>

Creates a new File instance by reading its contents from the filesystem.

This is the primary factory function for creating a File from a disk source. It handles determining the file’s logical name relative to the workspace, reading its contents, and robustly handling non-UTF-8 text via lossy conversion.

Arguments

• workspace: The root directory of the project, used to calculate the logical name.
• path: The absolute path to the file to read from disk.
• file_type: The FileType to assign to the created file.

Errors

Returns a DatabaseError::IOError if the file cannot be read from the disk.

pub fn ephemeral(name: String, contents: String) -> Self

Creates an ephemeral, in-memory File from a name and content.

This is a convenience method for situations like testing or formatting where a full file context (e.g., a real path) is not required. It defaults to FileType::Host and a path of None.

pub fn line_number(&self, offset: usize) -> usize

Retrieve the line number for the given byte offset.

Parameters

• offset: The byte offset to retrieve the line number for.

Returns

The line number for the given byte offset (0-based index).

pub fn get_line_start_offset(&self, line: usize) -> Option<usize>

Retrieve the byte offset for the start of the given line.

Parameters

• line: The line number to retrieve the start offset for.

Returns

The byte offset for the start of the given line (0-based index).

pub fn get_line_end_offset(&self, line: usize) -> Option<usize>

Retrieve the byte offset for the end of the given line.

Parameters

• line: The line number to retrieve the end offset for.

Returns

The byte offset for the end of the given line (0-based index).

pub fn column_number(&self, offset: usize) -> usize

Retrieve the column number for the given byte offset.

Parameters

• offset: The byte offset to retrieve the column number for.

Returns

The column number for the given byte offset (0-based index).

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl HasFileId for File

fn file_id(&self) -> FileId

Returns the unique identifier of the file.

impl Hash for File

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for File

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

impl StructuralPartialEq for File