Struct Checker

pub struct Checker<Type> {
    pub name: &'static str,
    pub description: &'static str,
    pub link: &'static str,
    pub tags: Vec<&'static str>,
    pub expected_runtime: f32,
    pub popularity: f32,
    pub lemmeknow_config: Identifier,
    pub sensitivity: Sensitivity,
    pub enhanced_detector: Option<()>,
    pub _phantom: PhantomData<Type>,
}

Every checker is of type CheckerType This will let us pick & choose which checkers to use at runtime.

Fields

name: &'static str

The name of the checker

description: &'static str

The description of the checker you can take the first line from Wikipedia Sometimes our checkers do not exist on Wikipedia so we write our own.

link: &'static str

The link to the checker’s website Wikipedia link, articles, github etc

tags: Vec<&'static str>

The tags of the checker

expected_runtime: f32

The expected runtime of the checker We get this by bench marking the code

popularity: f32

The popularity of the checker

lemmeknow_config: Identifier

lemmeknow config object

sensitivity: Sensitivity

The sensitivity level for gibberish detection This is only used by checkers that implement the SensitivityAware trait

enhanced_detector: Option<()>

Enhanced gibberish detector using BERT model This is only used when enhanced detection is enabled

_phantom: PhantomData<Type>

https://doc.rust-lang.org/std/marker/struct.PhantomData.html Let’s us save memory by telling the compiler that our type acts like a type even though it doesn’t. Stops the compiler complaining, else we’d need to implement some magic to make it work.

Trait Implementations

impl Check for Checker<Athena>

fn new() -> Self

Returns a new struct of type CheckerType

fn check(&self, text: &str) -> CheckResult

Checks the given text to see if its plaintext

fn with_sensitivity(self, sensitivity: Sensitivity) -> Self

Sets the sensitivity level for gibberish detection

fn get_sensitivity(&self) -> Sensitivity

Gets the current sensitivity level

impl Check for Checker<DefaultChecker>

fn new() -> Self

Returns a new struct of type CheckerType

fn check(&self, _text: &str) -> CheckResult

Checks the given text to see if its plaintext

fn with_sensitivity(self, sensitivity: Sensitivity) -> Self

Sets the sensitivity level for gibberish detection

fn get_sensitivity(&self) -> Sensitivity

Gets the current sensitivity level

impl Check for Checker<EnglishChecker>

given an input, check every item in the array and return true if any of them match

fn new() -> Self

Returns a new struct of type CheckerType

fn check(&self, text: &str) -> CheckResult

Checks the given text to see if its plaintext

fn with_sensitivity(self, sensitivity: Sensitivity) -> Self

Sets the sensitivity level for gibberish detection

fn get_sensitivity(&self) -> Sensitivity

Gets the current sensitivity level

impl Check for Checker<LemmeKnow>

fn new() -> Self

Returns a new struct of type CheckerType

fn check(&self, text: &str) -> CheckResult

Checks the given text to see if its plaintext

fn with_sensitivity(self, sensitivity: Sensitivity) -> Self

Sets the sensitivity level for gibberish detection

fn get_sensitivity(&self) -> Sensitivity

Gets the current sensitivity level

impl Check for Checker<PasswordChecker>

Implementation of the Check trait for PasswordChecker

fn new() -> Self

Returns a new struct of type CheckerType

fn check(&self, text: &str) -> CheckResult

Checks the given text to see if its plaintext

fn with_sensitivity(self, sensitivity: Sensitivity) -> Self

Sets the sensitivity level for gibberish detection

fn get_sensitivity(&self) -> Sensitivity

Gets the current sensitivity level

impl Check for Checker<RegexChecker>

fn new() -> Self

Returns a new struct of type CheckerType

fn check(&self, text: &str) -> CheckResult

Checks the given text to see if its plaintext

fn with_sensitivity(self, sensitivity: Sensitivity) -> Self

Sets the sensitivity level for gibberish detection

fn get_sensitivity(&self) -> Sensitivity

Gets the current sensitivity level

impl Check for Checker<WaitAthena>

fn new() -> Self

Returns a new struct of type CheckerType

fn check(&self, text: &str) -> CheckResult

Checks the given text to see if its plaintext

fn with_sensitivity(self, sensitivity: Sensitivity) -> Self

Sets the sensitivity level for gibberish detection

fn get_sensitivity(&self) -> Sensitivity

Gets the current sensitivity level

impl Check for Checker<WordlistChecker>

fn new() -> Self

Returns a new struct of type CheckerType

fn check(&self, text: &str) -> CheckResult

Checks the given text to see if its plaintext

fn with_sensitivity(self, sensitivity: Sensitivity) -> Self

Sets the sensitivity level for gibberish detection

fn get_sensitivity(&self) -> Sensitivity

Gets the current sensitivity level