Struct LedgerHistoryConfig 

pub struct LedgerHistoryConfig {
    pub list_transactions: Option<LedgerHistoryMethodConfig>,
    pub list_events: Option<LedgerHistoryMethodConfig>,
    pub list_checkpoints: Option<LedgerHistoryMethodConfig>,
    pub bitmap_bucket_scan_budget: Option<usize>,
    pub chunk_bucket_scan_budget: Option<usize>,
    pub max_bitmap_filter_literals: Option<usize>,
}

Tunables for the ledger-history list APIs. Per-endpoint knobs live in the three LedgerHistoryMethodConfig fields; the remaining knobs are global across all three. Every field is optional and falls back to a built-in default.

Fields

list_transactions: Option<LedgerHistoryMethodConfig>

Per-endpoint tunables for list_transactions.

list_events: Option<LedgerHistoryMethodConfig>

Per-endpoint tunables for list_events.

list_checkpoints: Option<LedgerHistoryMethodConfig>

Per-endpoint tunables for list_checkpoints.

bitmap_bucket_scan_budget: Option<usize>

Total evaluated-bucket budget for one filtered request, shared by all three list APIs. Exhausting it ends the query with SCAN_LIMIT and a resume cursor, bounding the worst-case scan cost of a sparse filter.

Defaults to 1024 if not specified.

chunk_bucket_scan_budget: Option<usize>

Per-chunk evaluated-bucket cap. A chunk that hits this while the request budget remains emits a progress watermark and resumes in the next chunk, so a long sparse scan reports incremental progress. Clamped to bitmap_bucket_scan_budget.

Defaults to 256 if not specified.

max_bitmap_filter_literals: Option<usize>

Maximum total filter literals (bitmap dimensions) accepted in one filtered request, across all DNF terms. Each literal becomes one bitmap leaf, so this bounds a single filter’s scan fanout. Must not exceed bitmap_bucket_scan_budget (see LedgerHistoryConfig::validate).

Defaults to 10 if not specified.

Implementations

impl LedgerHistoryConfig

pub fn list_transactions(&self) -> ResolvedLedgerHistoryMethodConfig

pub fn list_events(&self) -> ResolvedLedgerHistoryMethodConfig

pub fn list_checkpoints(&self) -> ResolvedLedgerHistoryMethodConfig

pub fn bitmap_bucket_scan_budget(&self) -> usize

pub fn chunk_bucket_scan_budget(&self) -> usize

pub fn max_bitmap_filter_literals(&self) -> usize

pub fn validate(&self) -> Result<()>

Reject configurations that cannot make forward progress. Each filter literal becomes one bitmap leaf that must fetch at least one bucket to emit its first watermark; if the per-request budget is below the literal cap a SCAN_LIMIT can fire before any merged watermark reaches the wire, leaving the client a cursorless QueryEnd it cannot resume from. Mirrors the archival/BigTable side’s LedgerHistoryConfig::validate.

Trait Implementations

impl Clone for LedgerHistoryConfig

fn clone(&self) -> LedgerHistoryConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LedgerHistoryConfig

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

Formats the value using the given formatter.

impl Default for LedgerHistoryConfig

fn default() -> LedgerHistoryConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LedgerHistoryConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for LedgerHistoryConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.