Finding

One credential found by scan.

Import

use helpers4::secret::Finding;

Cargo feature secret (enabled by default). To compile only this module:

cargo add helpers4 --no-default-features --features secret

or in Cargo.toml:

[dependencies]
helpers4 = { version = "0.0.6", default-features = false, features = ["secret"] }

Definition

pub struct Finding { /* private fields */ }

Examples

use helpers4::secret::{scan, TokenKind};

let text = "key=AKIAIOSFODNN7EXAMPLE";
let finding = &scan(text)[0];
assert_eq!(finding.kind(), TokenKind::AwsAccessKey);
assert_eq!(&text[finding.start()..finding.end()], "AKIAIOSFODNN7EXAMPLE");

Methods

kind

pub fn kind(&self) -> TokenKind

The kind of credential.

Returns

TokenKind — The recognized TokenKind.

start

pub fn start(&self) -> usize

The byte offset where the credential starts in the scanned text.

Returns

usize — The start, a character boundary.

end

pub fn end(&self) -> usize

The byte offset just past the end of the credential.

Returns

usize — The end, a character boundary.

Source

src/secret/scan.rs