Struct GetConsensusState 

pub(crate) struct GetConsensusState<R: Runtime> {
    cache_usage: CacheUsage,
    after: Option<SystemTime>,
    next: Option<GetCertsState<R>>,
    authority_ids: Vec<RsaIdentity>,
    rt: R,
    config: Arc<DirMgrConfig>,
    prev_netdir: Option<Arc<dyn PreviousNetDir>>,
    filter: Arc<dyn DirFilter>,
}

Initial state: fetching or loading a consensus directory.

Fields

cache_usage: CacheUsage

How should we get the consensus from the cache, if at all?

after: Option<SystemTime>

If present, a time after which we want our consensus to have been published.

next: Option<GetCertsState<R>>

If present, our next state.

(This is present once we have a consensus.)

authority_ids: Vec<RsaIdentity>

A list of RsaIdentity for the authorities that we believe in.

No consensus can be valid unless it purports to be signed by more than half of these authorities.

rt: R

A Runtime implementation.

config: Arc<DirMgrConfig>

The configuration of the directory manager. Used for download configuration purposes.

prev_netdir: Option<Arc<dyn PreviousNetDir>>

If one exists, the netdir we’re trying to update.

filter: Arc<dyn DirFilter>

A filter that gets applied to directory objects before we use them.

Implementations

impl<R: Runtime> GetConsensusState<R>

pub(crate) fn new( rt: R, config: Arc<DirMgrConfig>, cache_usage: CacheUsage, prev_netdir: Option<Arc<dyn PreviousNetDir>>, filter: Arc<dyn DirFilter>, ) -> Self

Create a new GetConsensusState, using the cache as per cache_usage and downloading as per the relevant sections of config. If prev_netdir is supplied, information from that directory may be used to complete the next one.

impl<R: Runtime> GetConsensusState<R>

fn add_consensus_text( &mut self, source: DocSource, text: &str, cutoff: Option<SystemTime>, changed: &mut bool, ) -> Result<&ConsensusMeta>

Helper: try to set the current consensus text from an input string text. Refuse it if the authorities could never be correct, or if it is ill-formed.

If cutoff is provided, treat any consensus older than cutoff as older-than-requested.

Errors from this method are not fatal to the download process.

fn recognizes_authority(&self, id: &RsaIdentity) -> bool

Return true if id is an authority identity we recognize

Trait Implementations

impl<R: Clone + Runtime> Clone for GetConsensusState<R>

fn clone(&self) -> GetConsensusState<R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: Debug + Runtime> Debug for GetConsensusState<R>

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

Formats the value using the given formatter.

impl<R: Runtime> DirState for GetConsensusState<R>

fn describe(&self) -> String

Return a human-readable description of this state.

fn missing_docs(&self) -> Vec<DocId>

Return a list of the documents we’re missing.

fn is_ready(&self, _ready: Readiness) -> bool

Describe whether this state has reached ready status.

fn can_advance(&self) -> bool

Return true if this state can advance to another state via its advance method.

fn bootstrap_progress(&self) -> DirProgress

Return a summary of this state as a DirProgress.

fn dl_config(&self) -> DownloadSchedule

Return a configuration for attempting downloads.

fn add_from_cache( &mut self, docs: HashMap<DocId, DocumentText>, changed: &mut bool, ) -> Result<()>

Add one or more documents from our cache; returns ‘true’ if there was any change in this state.

fn add_from_download( &mut self, text: &str, request: &ClientRequest, source: DocSource, storage: Option<&Mutex<Box<dyn Store>>>, changed: &mut bool, ) -> Result<()>

Add information that we have just downloaded to this state.

fn advance(self: Box<Self>) -> Box<dyn DirState>

If possible, advance to the next state.

fn reset_time(&self) -> Option<SystemTime>

Return a time (if any) when downloaders should stop attempting to advance this state, and should instead reset it and start over.

fn reset(self: Box<Self>) -> Box<dyn DirState>

Reset this state and start over.

fn get_netdir_change(&mut self) -> Option<NetDirChange<'_>>

If the state object wants to make changes to the currently running NetDir, return the proposed changes.