Skip to main content

CaptureError

Enum CaptureError 

Source
#[non_exhaustive]
pub enum CaptureError { NoInterface { refused: Vec<(String, CaptureError)>, }, NoReader { opened: usize, source: Error, }, UnsupportedLinkType { interface: String, dlt: i32, }, Filter { filter: String, source: LibraryError, }, Open { interface: String, source: LibraryError, }, Denied { interface: String, source: LibraryError, }, OutOfDescriptors { links: Vec<String>, }, }
Expand description

Why a capture could not be started.

An interface that cannot be captured is skipped and logged: a host has several, most irrelevant to a given probe, and a virtual bridge declining should not stop a scan. Only every interface failing leaves nowhere to hear an answer, and that is NoInterface, which carries each link’s own refusal.

Privilege is one cause among several and is named only where it is the cause. A root process can be refused a capture by a filter the link cannot express, a framing nothing here parses, or an adapter the capture driver will not bind, and blaming privilege for those misleads someone who already has it. is_denied is the question to ask.

#[non_exhaustive] because new platform-specific failures show up first in the capture layer.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

NoInterface

No link could be captured on, so nothing could be heard.

Carries every link’s refusal, since they need not agree and the reason is what there is to act on. Where every one was Denied the message says so in one sentence, the ordinary case of an unprivileged process; otherwise it gives each reason once, naming the link where one link gave it and counting them where several did.

Fields

§refused: Vec<(String, CaptureError)>

Each link tried, by name, and why it could not be captured on, in the order tried.

§

NoReader

Every link opened and none could be given a reader thread.

A runtime condition: a process near its thread limit, or a cgroup capping them. Separate from NoInterface because the remedy differs and has nothing to do with privilege.

Fields

§opened: usize

How many links opened before the threads were asked for.

§source: Error

What the last spawn refused with.

§

UnsupportedLinkType

A link carries frames this crate cannot strip down to an IP packet.

The capture came up, but its data-link type is one nothing here parses. Skipped, since guessing at a framing would report a network that is not there.

Fields

§interface: String

The link that was opened.

§dlt: i32

The libpcap data-link type it reported.

§

Filter

The filter expression would not compile to a BPF program.

Either a mistake in the expression or a link that cannot express it: an Ethernet address means nothing on a tunnel, and libpcap refuses to compile one for it. Either way the expression is what to look at, so it is named.

Fields

§filter: String

The expression that was rejected.

§source: LibraryError

What libpcap said.

§

Open

One named link could not be opened, for a reason other than privilege. Unlike NoInterface this names the link, because the caller asked for that one and there is nothing to fall back to.

Fields

§interface: String

The link that refused.

§source: LibraryError

What libpcap said.

§

Denied

One named link could not be opened because this process may not capture on it.

Separate from Open because its remedy lies outside the link: root, or whatever grants the right to capture short of it, such as membership of access_bpf on macOS or cap_net_raw on Linux. Decided by the status libpcap activated the handle with, not by its message.

Fields

§interface: String

The link that refused.

§source: LibraryError

What libpcap said.

§

OutOfDescriptors

The process or the system ran out of descriptors partway through the links, so a capture would have been deaf on the links it did not reach.

Not skipped like a link that declines. A declining link is one the scan’s targets do not answer through; these are refused for a local shortage, and any of them may be where the replies arrive. Heard on the rest alone, those replies would read as targets that did not answer.

Fields

§links: Vec<String>

The links refused a capture, by name, in the order they were tried.

Implementations§

Source§

impl CaptureError

Source

pub fn is_denied(&self) -> bool

Whether this failure is a missing privilege and nothing else.

True of a link that Denied this process, and of a capture with no link because every link did. A capture refused on other grounds, even alongside links that denied it, answers false: the privilege would not have made it work.

Trait Implementations§

Source§

impl Coded for CaptureError

Source§

fn code(&self) -> &'static str

A short, stable name for what went wrong. Read more
Source§

impl Debug for CaptureError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for CaptureError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for CaptureError

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<CaptureError> for StrategyError

Source§

fn from(source: CaptureError) -> Self

Converts to this type from the input type.
Source§

impl From<CaptureError> for TransportError

Source§

fn from(source: CaptureError) -> Self

Converts to this type from the input type.

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
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