Struct Disassembly 

pub struct Disassembly { /* private fields */ }

The outcome of parsing one class-file input.

A complete result contains a Class. Best-effort recovery returns a partial result when only the class-file header was available; callers can inspect Self::version and Self::diagnostics in that case.

Implementations

impl Disassembly

pub fn version(&self) -> ClassVersion

Returns the class-file version read from the input header.

This is available for both complete and partial results.

Examples found in repository

examples/disassemble.rs (line 25)

fn run() -> Result<ExitCode, String> {
    let path = class_path()?;
    let file =
        File::open(&path).map_err(|error| format!("could not open {}: {error}", path.display()))?;
    let disassembly = Disassembler::default()
        .parse_reader(file)
        .map_err(|error| format!("could not parse {}: {error}", path.display()))?;

    let version = disassembly.version();
    let Some(class) = disassembly.class() else {
        println!(
            "partial class file v{}.{}",
            version.major(),
            version.minor()
        );
        for diagnostic in disassembly.diagnostics() {
            print_diagnostic(diagnostic);
        }
        return Ok(ExitCode::from(2));
    };

    let output = FerroFormatter
        .format(class)
        .map_err(|error| format!("could not format {}: {error}", path.display()))?;
    print!("{output}");

    Ok(ExitCode::SUCCESS)
}

pub fn is_complete(&self) -> bool

Returns true when a complete Class model is available.

pub fn class(&self) -> Option<&Class>

Returns the complete parsed class, if decoding finished successfully.

Returns None for a best-effort partial result.

Examples found in repository

examples/disassemble.rs (line 26)

fn run() -> Result<ExitCode, String> {
    let path = class_path()?;
    let file =
        File::open(&path).map_err(|error| format!("could not open {}: {error}", path.display()))?;
    let disassembly = Disassembler::default()
        .parse_reader(file)
        .map_err(|error| format!("could not parse {}: {error}", path.display()))?;

    let version = disassembly.version();
    let Some(class) = disassembly.class() else {
        println!(
            "partial class file v{}.{}",
            version.major(),
            version.minor()
        );
        for diagnostic in disassembly.diagnostics() {
            print_diagnostic(diagnostic);
        }
        return Ok(ExitCode::from(2));
    };

    let output = FerroFormatter
        .format(class)
        .map_err(|error| format!("could not format {}: {error}", path.display()))?;
    print!("{output}");

    Ok(ExitCode::SUCCESS)
}

pub fn diagnostics(&self) -> &[Diagnostic]

Returns diagnostics collected during best-effort recovery.

Complete results currently return an empty slice.

Examples found in repository

examples/disassemble.rs (line 32)

fn run() -> Result<ExitCode, String> {
    let path = class_path()?;
    let file =
        File::open(&path).map_err(|error| format!("could not open {}: {error}", path.display()))?;
    let disassembly = Disassembler::default()
        .parse_reader(file)
        .map_err(|error| format!("could not parse {}: {error}", path.display()))?;

    let version = disassembly.version();
    let Some(class) = disassembly.class() else {
        println!(
            "partial class file v{}.{}",
            version.major(),
            version.minor()
        );
        for diagnostic in disassembly.diagnostics() {
            print_diagnostic(diagnostic);
        }
        return Ok(ExitCode::from(2));
    };

    let output = FerroFormatter
        .format(class)
        .map_err(|error| format!("could not format {}: {error}", path.display()))?;
    print!("{output}");

    Ok(ExitCode::SUCCESS)
}

Trait Implementations

impl Clone for Disassembly

fn clone(&self) -> Disassembly

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Disassembly

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

Formats the value using the given formatter.