Skip to main content

ScanHandle

Struct ScanHandle 

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

Live state of one scan.

All fields are Arc<…> because handles are shared between the background scan task and any number of HTTP request handlers.

Implementations§

Source§

impl ScanHandle

Source

pub fn new( username: impl Into<String>, site_count: usize, outcome_buffer: usize, ) -> Self

Construct an empty handle ready to accept outcomes.

site_count is the size of the site list this scan will run against — surfaced through Self::site_count so the UI can render 423 / 1890 progress without holding open an SSE stream. outcome_buffer sizes the broadcast ring buffer; a value substantially larger than site_count is fine — the cost is one Arc<…> slot per buffered notification.

Source

pub fn username(&self) -> &str

Username being scanned (for display / debugging).

Source

pub fn site_count(&self) -> usize

Total number of sites this scan will / did probe.

Source

pub fn elapsed(&self) -> Duration

Wall-clock time since the handle was created.

Source

pub fn created_at_ms(&self) -> u64

Unix epoch milliseconds when this handle was constructed. Used by the history endpoint so the UI can render relative times.

Source

pub async fn outcomes_snapshot(&self) -> Vec<CheckOutcome>

Snapshot of outcomes recorded so far. Cheap clone — Vec deep-clones only the small number of strings inside each CheckOutcome.

Source

pub async fn finished(&self) -> Option<FinishedScan>

Final aggregate, once the scan has completed. None while running.

Source

pub fn is_finished_now(&self) -> bool

Best-effort sync peek used by the eviction policy. Returns false if the lock is currently held — a momentarily-locked finished slot is, by construction, still being mutated.

Source

pub fn subscribe(&self) -> Receiver<usize>

Subscribe to “new outcome appended at index N” notifications. Combine with Self::outcomes_snapshot for “replay then live” semantics.

Source

pub async fn wait_done(&self)

Wait until the scan finishes. Idempotent — fires for every caller registered before or after the scan completes (the finished field is the source of truth; this is just a wake-up).

Trait Implementations§

Source§

impl Clone for ScanHandle

Source§

fn clone(&self) -> ScanHandle

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 Debug for ScanHandle

Source§

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

Formats the value using the given formatter. 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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> 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> 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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