Struct retdec::analysis::Analysis

pub struct Analysis { /* fields omitted */ }

Analysis from the fileinfo service.

Methods

impl Analysis

fn id(&self) -> &str

Returns the ID of the analysis.

Does not access the API.

fn finished(&self) -> bool

Has the analysis finished?

Does not access the API, so the returned value may be outdated. In a greater detail, when it returns true, the analysis has surely finished. However, when it returns false, the analysis might or might not have finished. If you want to have an up-to-date information, use has_finished() instead.

fn has_finished(&mut self) -> Result<bool>

Has the analysis finished?

Accesses the API.

fn succeeded(&self) -> bool

Has the analysis succeeded?

Does not access the API, so the returned value may be outdated. If you want to have an up-to-date information, use has_succeeded() instead.

The returned value makes sense only when the analysis has finished.

fn has_succeeded(&mut self) -> Result<bool>

Has the analysis succeeded?

Accesses the API.

The returned value makes sense only when the analysis has finished.

fn failed(&self) -> bool

Has the analysis failed?

Does not access the API, so the returned value may be outdated. If you want to have an up-to-date information, use has_failed() instead.

The returned value makes sense only when the analysis has finished.

fn has_failed(&mut self) -> Result<bool>

Has the analysis failed?

Accesses the API.

The returned value makes sense only when the analysis has finished.

fn error(&self) -> Option<&str>

Returns the error message (if any).

Does not access the API, so the returned value may be outdated. If you want to have an up-to-date information, use get_error() instead.

Calling this method makes sense only when the analysis has failed. Otherwise, it will always return None.

fn get_error(&mut self) -> Result<Option<&str>>

Returns the error message (if any).

Accesses the API.

Calling this method makes sense only when the analysis has failed. Otherwise, it will always return None.

fn wait_until_finished(&mut self) -> Result<()>

Waits until the analysis has finished.

When this method returns Ok(), the analysis has finished.

Accesses the API.

fn get_output(&mut self) -> Result<String>

Returns the output from the analysis.

The format of the output depends on the format selected when starting an analysis (output_format).

Accesses the API.

fn get_output_as_file(&mut self) -> Result<File>

Returns the output from the analysis as a file.

The format of the output depends on the format selected when starting an analysis (output_format).

Accesses the API.