Struct lemmeknow::identifier::bytes::Identifier

pub struct Identifier {
    pub min_rarity: f32,
    pub max_rarity: f32,
    pub tags: Vec<String>,
    pub exclude_tags: Vec<String>,
    pub boundaryless: bool,
    pub file_support: bool,
}

Fields

min_rarity: f32

Keep Data having minimum Rarity of supplied min_rarity

max_rarity: f32

Keep Data having maximum Rarity of supplied max_rarity

tags: Vec<String>

Only include the Data which have at least one of the specified tags

exclude_tags: Vec<String>

Only include Data which doesn’t have any of the excluded_tags

boundaryless: bool

Use boundaryless regex

file_support: bool

Scan files having supplied text as filename

Implementations

impl Identifier

pub fn min_rarity(self, rarity: f32) -> Self

pub fn max_rarity(self, rarity: f32) -> Self

pub fn include_tags(self, tags: &[String]) -> Self

pub fn exclude_tags(self, tags: &[String]) -> Self

pub fn boundaryless(self, boundaryless: bool) -> Self

pub fn file_support(self, support: bool) -> Self

impl Identifier

pub fn identify(&self, text: &[u8]) -> Vec<Match>

Identify the given bytes.

Finds all possible identifications.

Arguments

• text: &u8 - text which we want to identify

Examples

let identifier = lemmeknow::bytes::Identifier::default();
let text = b"UC11L3JDgDQMyH8iolKkVZ4w";
let result = identifier.identify(text);
assert_eq!(result[0].data.name, "YouTube Channel ID");

pub fn first_match(&self, text: &[u8]) -> Option<Match>

This returns the first identification.

Due to how data is stored, this means that the returned result has the highest rarity.

Arguments

• text: &u8 - text which we want to identify

Examples

let identifier = lemmeknow::bytes::Identifier::default();
let some_result = identifier.first_match(b"8888888888");
let not_gonna_find = identifier.first_match(b"a friend for swanandx");
  
assert_eq!(some_result.unwrap().data.name, "Phone Number");
assert!(not_gonna_find.is_none());

impl Identifier

pub fn to_json(result: &[Match]) -> String

Convert Vec<Match> to JSON

Returns prettified JSON string.

Helpful if you want to convert possible identifications to JSON for using in web APIs or something else.

Arguments

• result: &Match - Reference to Vec<Match>.

Examples

use lemmeknow::Identifier;
let identifier = Identifier::default();
let result = identifier.identify("UC11L3JDgDQMyH8iolKkVZ4w");
let result_in_json = Identifier::to_json(&result);
println!("{result_in_json}");

Trait Implementations

impl Default for Identifier

fn default() -> Self

Returns the “default value” for a type.