Struct CodeQLExtractor

pub struct CodeQLExtractor {
    pub path: PathBuf,
    pub name: String,
    pub display_name: String,
    pub version: String,
    pub build_modes: Vec<String>,
    pub column_kind: Option<String>,
    pub legacy_qltest_extraction: Option<bool>,
    pub github_api_languages: Option<Vec<String>>,
    pub scc_languages: Option<Vec<String>>,
    pub file_types: Vec<CodeQLExtractorFileType>,
}

CodeQL Extractor

use ghastoolkit::codeql::CodeQLExtractor;

let extractor = CodeQLExtractor::load(r#"
    name: "rust"
    display_name: "Rust"
    version: 0.1.0
    column_kind: "utf8"
    legacy_qltest_extraction: true
    github_api_languages:
      - Rust
    scc_languages:
      - Rust
    file_types:
      - name: rust
        display_name: Rust
        extensions:
          - rs

"#).unwrap();

Fields

path: PathBuf

Root Directory of the extractor-pack

name: String

The name of the extractor

display_name: String

The display name of the extractor

version: String

The version of the extractor

build_modes: Vec<String>

The build modes

column_kind: Option<String>

Column kind

legacy_qltest_extraction: Option<bool>

Legacy QLTest extraction

github_api_languages: Option<Vec<String>>

GitHub API languages

scc_languages: Option<Vec<String>>

SCC languages

file_types: Vec<CodeQLExtractorFileType>

File types

Implementations

impl CodeQLExtractor

pub fn load(content: &str) -> Result<Self, GHASError>

Load CodeQL Extractor from a string

pub fn load_path(path: impl Into<PathBuf>) -> Result<Self, GHASError>

Load CodeQL Extractor from a file

pub fn languages(&self) -> Vec<String>

Get supported languages for an extractor

pub fn build_modes(&self) -> Vec<BuildMode>

Get the build modes

Trait Implementations

impl Clone for CodeQLExtractor

fn clone(&self) -> CodeQLExtractor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodeQLExtractor

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

Formats the value using the given formatter.

impl Default for CodeQLExtractor

fn default() -> CodeQLExtractor

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CodeQLExtractor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for CodeQLExtractor

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 Ord for CodeQLExtractor

fn cmp(&self, other: &CodeQLExtractor) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CodeQLExtractor

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

fn partial_cmp(&self, other: &CodeQLExtractor) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for CodeQLExtractor

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PathBuf> for CodeQLExtractor

type Error = GHASError

The type returned in the event of a conversion error.

fn try_from(path: PathBuf) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for CodeQLExtractor

impl StructuralPartialEq for CodeQLExtractor