Struct SourceFile 

pub struct SourceFile { /* private fields */ }

Represents a VB6 source file with its content and filename. This struct provides methods to read and decode source files using Windows-1252 encoding.

Implementations

impl SourceFile

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self, ErrorDetails<'static>>

Creates a SourceFile by reading from a file path.

This method reads the file at the given path, decodes it using Windows-1252 encoding with replacement for invalid characters, and extracts the filename from the path.

Arguments

• path - A path to the file to read

Returns

Returns a Result containing either:

• Ok(SourceFile) - Successfully read and decoded file
• Err(ErrorDetails) - Error reading the file or decoding its contents

Errors

This function will return an error if:

• The file cannot be read
• The file content cannot be decoded

Example

use vb6parse::io::SourceFile;

let source_file = SourceFile::from_file("path/to/module.bas");

match source_file {
   Ok(file) => println!("Successfully read source file: {}", file.file_name()),
   Err(e) => e.print(),
}

pub fn file_name(&self) -> &str

Returns the source file name

pub fn from_string( file_name: impl Into<String>, source_code: impl Into<String>, ) -> Self

Creates a SourceFile from a file name and source code string.

Arguments

• file_name - The name of the source file
• source_code - The source code as a string

Returns

Returns a SourceFile instance.

pub fn decode_with_replacement( file_name: impl Into<String>, source_code: &[u8], ) -> Result<Self, ErrorDetails<'_>>

Decodes the source code using Windows-1252 encoding with replacement for invalid characters.

Arguments

• file_name - The name of the source file
• source_code - The byte slice containing the source code to decode

Returns

Returns a Result containing either:

• Ok(SourceFile) - Successfully decoded source file
• Err(ErrorDetails) - Error decoding the source code

Errors

This function will return an error if the source code contains invalid characters that cannot be replaced. Any character that is representable within the Windows-1252 encoding will be decoded successfully and will be replaced with the Unicode equivalent.

A good example of invalid characters would be any chinese characters, as they are not representable within the Windows-1252 encoding.

pub fn decode( file_name: impl Into<String>, source_code: &[u8], ) -> Result<Self, ErrorDetails<'_>>

Decodes the source code using Windows-1252 encoding without allowing replacement for invalid characters.

Arguments

• file_name - The name of the source file
• source_code - The byte slice containing the source code to decode

Returns

Returns a Result containing either:

• Ok(SourceFile) - Successfully decoded source file
• Err(ErrorDetails) - Error decoding the source code

Errors

This function will return an error if the source code contains any invalid characters that cannot be represented in Windows-1252 encoding. All characters in the source code must be valid Windows-1252 characters for successful decoding. A good example of invalid characters would be any chinese characters, as they are not representable within the Windows-1252 encoding.

pub fn source_stream(&self) -> SourceStream<'_>

Creates a SourceStream from the SourceFile.

This method initializes a SourceStream using the file name and content of the SourceFile.

Returns

Returns a SourceStream instance.

Trait Implementations

impl AsRef<str> for SourceFile

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SourceFile

fn clone(&self) -> SourceFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceFile

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

Formats the value using the given formatter.

impl Display for SourceFile

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

Formats the value using the given formatter.