scanner::IScanner Interface Reference

Defines the primary contract for the file scanning engine. More...

#include <interfaces.h>

Inheritance diagram for scanner::IScanner:

Collaboration diagram for scanner::IScanner:

Public Member Functions
virtual	~IScanner ()=default
virtual ScanResult	Scan (const std::filesystem::path &scan_path)=0
	Recursively scans a directory for malicious files.

Detailed Description

Defines the primary contract for the file scanning engine.

Constructor & Destructor Documentation

~IScanner()

virtual scanner::IScanner::~IScanner ( )

virtualdefault

Member Function Documentation

Scan()

virtual ScanResult scanner::IScanner::Scan ( const std::filesystem::path &  scan_path )

pure virtual

Recursively scans a directory for malicious files.

This method orchestrates the entire scanning process, utilizing multiple threads to hash files and check them against the database.

Parameters

scan_path

The root directory to begin the scan from.

Returns

A ScanResult struct containing the statistics of the completed scan.

Implemented in scanner::Scanner.

---

The documentation for this interface was generated from the following file:

• include/scanner/interfaces.h