Struct feroxbuster::scan_manager::FeroxScans

pub struct FeroxScans {
    pub scans: RwLock<Vec<Arc<FeroxScan>>>,
    // some fields omitted
}

Container around a locked hashset of FeroxScans, adds wrappers for insertion and searching

Fields

scans: RwLock<Vec<Arc<FeroxScan>>>

Internal structure: locked hashset of FeroxScans

Implementations

impl FeroxScans

Implementation of FeroxScans

pub fn new(output_level: OutputLevel) -> Self

given an OutputLevel, create a new FeroxScans object

pub fn insert(&self, scan: Arc<FeroxScan>) -> bool

Add a FeroxScan to the internal container

If the internal container did NOT contain the scan, true is returned; else false

pub fn add_serialized_scans(&self, filename: &str) -> Result<()>

load serialized FeroxScan(s) into this FeroxScans

pub fn contains(&self, url: &str) -> bool

Simple check for whether or not a FeroxScan is contained within the inner container based on the given URL

pub fn get_scan_by_url(&self, url: &str) -> Option<Arc<FeroxScan>>

Find and return a FeroxScan based on the given URL

pub fn increment_status_code(&self, url: &str, code: StatusCode)

add one to either 403 or 429 tracker in the scan related to the given url

pub fn increment_error(&self, url: &str)

add one to either 403 or 429 tracker in the scan related to the given url

pub async fn display_scans(&self)

Print all FeroxScans of type Directory

Example: 0: complete https://10.129.45.20 9: complete https://10.129.45.20/images 10: complete https://10.129.45.20/assets

pub fn print_known_responses(&self)

prints all known responses that the scanner has already seen

pub fn print_completed_bars(&self, bar_length: usize) -> Result<()>

if a resumed scan is already complete, display a completed progress bar to the user

pub async fn pause(&self, get_user_input: bool) -> usize

Forced the calling thread into a busy loop

Every SLEEP_DURATION milliseconds, the function examines the result stored in PAUSE_SCAN

When the value stored in PAUSE_SCAN becomes false, the function returns, exiting the busy loop

pub fn set_bar_length(&self, bar_length: u64)

set the bar length of FeroxScans

pub fn add_directory_scan(
    &self,
    url: &str,
    scan_order: ScanOrder
) -> (bool, Arc<FeroxScan>)

Given a url, create a new FeroxScan and add it to FeroxScans as a Directory Scan

If FeroxScans did not already contain the scan, return true; otherwise return false

Also return a reference to the new FeroxScan

pub fn add_file_scan(
    &self,
    url: &str,
    scan_order: ScanOrder
) -> (bool, Arc<FeroxScan>)

Given a url, create a new FeroxScan and add it to FeroxScans as a File Scan

If FeroxScans did not already contain the scan, return true; otherwise return false

Also return a reference to the new FeroxScan

pub fn has_active_scans(&self) -> bool

small helper to determine whether any scans are active or not

pub fn get_active_scans(&self) -> Vec<Arc<FeroxScan>>

Retrieve all active scans

Trait Implementations

impl Debug for FeroxScans

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FeroxScans

fn default() -> FeroxScans

Returns the “default value” for a type.

impl Serialize for FeroxScans

Serialize implementation for FeroxScans

purposefully skips menu attribute

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Function that handles serialization of FeroxScans