Skip to main content

StringTracker

Struct StringTracker 

Source
pub struct StringTracker { /* private fields */ }
Expand description

Thread-safe, bounded in-memory string tracker.

Implementations§

Source§

impl StringTracker

Source

pub fn new() -> Self

Create a tracker with validated defaults and built-in heuristics.

Source

pub fn with_config(config: AnalysisConfig) -> AnalysisResult<Self>

Create a tracker with built-in components and validated limits.

Source

pub fn with_components( analyzer: Box<dyn StringAnalyzer>, categorizer: Box<dyn Categorizer>, ) -> Self

Create a tracker with custom components and default limits.

Source

pub fn with_components_and_config( analyzer: Box<dyn StringAnalyzer>, categorizer: Box<dyn Categorizer>, config: AnalysisConfig, ) -> AnalysisResult<Self>

Create a tracker with custom components and validated limits.

Source

pub fn config(&self) -> &AnalysisConfig

Return this tracker’s immutable configuration.

Source

pub fn track_string( &self, value: &str, file_path: &str, file_hash: &str, tool_name: &str, context: StringContext, ) -> AnalysisResult<()>

Track an occurrence using the current UTC time.

Source

pub fn track_occurrence( &self, value: &str, occurrence: StringOccurrence, ) -> AnalysisResult<()>

Track an occurrence with a caller-supplied event timestamp.

Source

pub fn track_strings( &self, strings: &[String], file_path: &str, file_hash: &str, tool_name: &str, ) -> AnalysisResult<()>

Track a batch and infer a context for each value.

The operation is sequential rather than transactional: if a later value fails validation or reaches capacity, earlier values remain tracked.

Source

pub fn track_strings_from_results( &self, strings: &[String], file_path: &str, file_hash: &str, tool_name: &str, ) -> AnalysisResult<()>

Compatibility alias for StringTracker::track_strings.

Source

pub fn get_statistics( &self, filter: Option<&StringFilter>, ) -> AnalysisResult<StringStatistics>

Calculate deterministic statistics for an optional validated filter.

Source

pub fn get_string_details(&self, value: &str) -> Option<StringEntry>

Return a cloned entry for an exact value.

Source

pub fn search_strings( &self, query: &str, limit: usize, ) -> AnalysisResult<Vec<StringEntry>>

Search values using Unicode lowercase substring matching.

Return related values using a deterministic, fixed-denominator score.

Source

pub fn clear(&self)

Clear all retained state without changing configuration or components.

Trait Implementations§

Source§

impl Clone for StringTracker

Source§

fn clone(&self) -> StringTracker

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for StringTracker

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.