Struct BootstrapStatus

pub struct BootstrapStatus { /* private fields */ }

Information about how ready a crate::TorClient is to handle requests.

Note that this status does not change monotonically: a TorClient can become more or less bootstrapped over time. (For example, a client can become less bootstrapped if it loses its internet connectivity, or if its directory information expires before it’s able to replace it.)

Implementations

impl BootstrapStatus

pub fn as_frac(&self) -> f32

Return a rough fraction (from 0.0 to 1.0) representing how far along the client’s bootstrapping efforts are.

0 is defined as “just started”; 1 is defined as “ready to use.”

pub fn ready_for_traffic(&self) -> bool

Return true if the status indicates that the client is ready for traffic.

For the purposes of this function, the client is “ready for traffic” if, as far as we know, we can start acting on a new client request immediately.

pub fn blocked(&self) -> Option<Blockage>

If the client is unable to make forward progress for some reason, return that reason.

(Returns None if the client doesn’t seem to be stuck.)

Caveats

This function provides a “best effort” diagnostic: there will always be some blockage types that it can’t diagnose correctly. It may declare that Arti is stuck for reasons that are incorrect; or it may declare that the client is not stuck when in fact no progress is being made.

Therefore, the caller should always use a certain amount of modesty when reporting these values to the user. For example, it’s probably better to say “Arti says it’s stuck because it can’t make connections to the internet” rather than “You are not on the internet.”

Trait Implementations

impl Clone for BootstrapStatus

fn clone(&self) -> BootstrapStatus

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BootstrapStatus

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

Formats the value using the given formatter.

impl Default for BootstrapStatus

fn default() -> BootstrapStatus

Returns the “default value” for a type.

impl Display for BootstrapStatus

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

Format this BootstrapStatus.

Note that the string returned by this function is designed for human readability, not for machine parsing. Other code should not depend on particular elements of this string.