fix warnings in cargo doc

This commit is contained in:
Bryan Stitt 2023-04-10 15:06:40 -07:00
parent 7250a0c155
commit 29c015508a
5 changed files with 6 additions and 8 deletions

@ -1,6 +1,4 @@
//! A counter of events in a time period.
//!
//! TODO: maybe better to do something like this though: https://github.com/facebookarchive/metrics/blob/master/ewma.go
use std::collections::VecDeque;
use tokio::time::{Duration, Instant};

@ -160,7 +160,7 @@ pub type AnyhowJoinHandle<T> = JoinHandle<anyhow::Result<T>>;
pub struct AuthorizationChecks {
/// database id of the primary user. 0 if anon
/// TODO: do we need this? its on the authorization so probably not
/// TODO: Option<NonZeroU64>?
/// TODO: `Option<NonZeroU64>`? they are actual zeroes some places in the db now
pub user_id: u64,
/// the key used (if any)
pub rpc_secret_key: Option<RpcSecretKey>,

@ -1,6 +1,6 @@
//! `frontend` contains HTTP and websocket endpoints for use by a website or web3 wallet.
//!
//! Important reading about axum extractors: https://docs.rs/axum/latest/axum/extract/index.html#the-order-of-extractors
//! Important reading about axum extractors: <https://docs.rs/axum/latest/axum/extract/index.html#the-order-of-extractors>
pub mod admin;
pub mod authorization;

@ -197,7 +197,7 @@ impl Web3Rpcs {
/// Get a block from caches with fallback.
/// Will query a specific node or the best available.
/// TODO: return Web3ProxyResult<Option<ArcBlock>>?
/// TODO: return `Web3ProxyResult<Option<ArcBlock>>`?
pub async fn block(
&self,
authorization: &Arc<Authorization>,

@ -90,9 +90,9 @@ type FirstSeenCache = Cache<H256, Instant, hashbrown::hash_map::DefaultHashBuild
/// A ConsensusConnections builder that tracks all connection heads across multiple groups of servers
pub struct ConsensusFinder {
/// backups for all tiers are only used if necessary
/// tiers[0] = only tier 0.
/// tiers[1] = tier 0 and tier 1
/// tiers[n] = tier 0..=n
/// `tiers[0] = only tier 0`
/// `tiers[1] = tier 0 and tier 1`
/// `tiers[n] = tier 0..=n`
/// This is a BTreeMap and not a Vec because sometimes a tier is empty
rpc_heads: HashMap<Arc<Web3Rpc>, Web3ProxyBlock>,
/// never serve blocks that are too old