Struct feroxbuster::scan_manager::FeroxScan

pub struct FeroxScan { /* fields omitted */ }

Struct to hold scan-related state

The purpose of this container is to open up the pathway to aborting currently running tasks and serialization of all scan state into a state file in order to resume scans that were cut short

Implementations

impl FeroxScan

Implementation of FeroxScan

pub async fn abort(&self) -> Result<()>

Stop a currently running scan

pub fn url(&self) -> &str

getter for url

pub async fn set_task(&self, task: JoinHandle<()>) -> Result<()>

small wrapper to set the JoinHandle

pub fn set_status(&self, status: ScanStatus) -> Result<()>

small wrapper to set ScanStatus

pub fn progress_bar(&self) -> ProgressBar

Simple helper get a progress bar

pub fn new(
    url: &str,
    scan_type: ScanType,
    scan_order: ScanOrder,
    num_requests: u64,
    output_level: OutputLevel,
    pb: Option<ProgressBar>
) -> Arc<Self>

Given a URL and ProgressBar, create a new FeroxScan, wrap it in an Arc and return it

pub fn finish(&self) -> Result<()>

Mark the scan as complete and stop the scan's progress bar

pub fn is_active(&self) -> bool

small wrapper to inspect ScanType and ScanStatus to see if a Directory scan is running or in the queue to be run

pub fn is_complete(&self) -> bool

small wrapper to inspect ScanStatus and see if it's Complete

pub async fn join(&self)

await a task's completion, similar to a thread's join; perform necessary bookkeeping

pub fn num_errors(&self, trigger: PolicyTrigger) -> usize

simple wrapper to call the appropriate getter based on the given PolicyTrigger

pub fn requests_per_second(&self) -> u64

return the number of requests per second performed by this scan's scanner

pub fn requests(&self) -> u64

return the number of requests performed by this scan's scanner

Trait Implementations

impl Debug for FeroxScan

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

Formats the value using the given formatter.

impl Default for FeroxScan

Default implementation for FeroxScan

fn default() -> Self

Create a default FeroxScan, populates ID with a new UUID

impl<'de> Deserialize<'de> for FeroxScan

Deserialize implementation for FeroxScan

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize a FeroxScan from a serde_json::Value

impl Display for FeroxScan

Display implementation

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

Formats the value using the given formatter.

impl PartialEq<FeroxScan> for FeroxScan

PartialEq implementation; uses FeroxScan.id for comparison

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Serialize for FeroxScan

Serialize implementation for FeroxScan

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

Function that handles serialization of a FeroxScan