Skip to main content

ScanSession

Struct ScanSession 

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

A handle to an active network scan: what it has found, what it is doing, and the means to stop it.

Returned by discover and scan alongside the ScanTask that resolves to the final report. This describes the present moment and keeps no history.

Dropping it stops nothing. Dropping the task stops the scan; see ScanTask.

use zond_engine::ScanEvent;

while let Some(event) = session.events().recv().await {
    if let ScanEvent::HostUpdated(ip) = event
        && let Some(host) = session.hosts().get(&ip)
    {
        println!("{host}");
    }
}

Implementations§

Source§

impl ScanSession

Source

pub fn hosts(&self) -> &HostStore

What the scan has found so far.

Once the scan is over this holds the hosts its report lists. While it runs it can hold more: a port scan with no liveness pass files a record at every address it asks and drops the silent ones when its ports are done, so an event naming such an address may find no host. See ScanPhase::silent.

Source

pub fn events(&mut self) -> &mut ScanEvents

The live event stream.

Bounded: a consumer that reads it slowly, or not at all, loses the oldest events. See ScanEvents.

Source

pub fn handle(&self) -> &ScanHandle

The control handle, which is how a scan is stopped early.

Source

pub fn progress(&self) -> &Progress

How far the scan has got through its plan.

Cloneable, so a caller rendering a scan elsewhere can take a copy. See Progress.

Source

pub fn into_parts(self) -> (HostStore, ScanEvents, ScanHandle, Progress)

Takes the session apart, for a caller that wants to watch the events from one task and read the hosts from another.

HostStore, ScanHandle and Progress are cloneable, so this is only needed to move the event stream, of which there is one.

Source§

impl ScanSession

Source

pub fn new() -> (Self, ScanContext)

A session and the context the strategies behind it write into, with nothing excluded, nothing resumed, no address numbering, and a walk order of its own; see SessionBuilder::ordering.

discover and scan build their own session. A caller orchestrating their own scan calls this first, since every strategy in strategy is constructed with a ScanContext.

builder takes further settings.

Source

pub fn builder() -> SessionBuilder

A session with exclusions, a resume point or an address numbering.

See SessionBuilder.

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more