Struct ghastoolkit::codeql::cli::CodeQL

pub struct CodeQL { /* private fields */ }

CodeQL CLI Wrapper to make it easier to run CodeQL commands

Implementations

impl CodeQL

pub fn new() -> Self

Create a new CodeQL instance

pub fn init() -> CodeQLBuilder

Initialize a new CodeQL Builder instance

pub fn find_codeql() -> Option<PathBuf>

Find CodeQL CLI on the system

pub fn run(&self, args: Vec<&str>) -> Result<String, GHASError>

Run a CodeQL command

pub fn database<'a>( &'a self, db: &'a CodeQLDatabase ) -> CodeQLDatabaseHandler<'_, '_>

Pass a CodeQLDatabase to the CodeQL CLI to return a CodeQLDatabaseHandler. This handler can be used to run queries and other operations on the database.

pub fn version(&self) -> Result<String, GHASError>

Get the version of the CodeQL CLI

pub fn get_languages(&self) -> Result<Vec<CodeQLLanguage>, GHASError>

Get the programming languages supported by the CodeQL CLI. This function will return the primary languages supported by the CodeQL and exclude any secondary languages (checkout get_secondary_languages()).

Example

use ghastoolkit::CodeQL;

let codeql = CodeQL::default();

let languages = codeql.get_languages()
    .expect("Failed to get languages");

for language in languages {
   println!("Language: {}", language.pretty());
   // Do something with the language
}

pub fn get_secondary_languages(&self) -> Result<Vec<CodeQLLanguage>, GHASError>

Get the secondary languages supported by the CodeQL CLI

pub fn get_all_languages(&self) -> Result<Vec<CodeQLLanguage>, GHASError>

Get all languages supported by the CodeQL CLI

Trait Implementations

impl Clone for CodeQL

fn clone(&self) -> CodeQL

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodeQL

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

Formats the value using the given formatter.

impl Default for CodeQL

fn default() -> Self

Returns the “default value” for a type.

impl Display for CodeQL

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

Formats the value using the given formatter.