Struct GcConfig

pub struct GcConfig {
    pub gc_blocks_limit: u64,
    pub gc_fork_clean_step: u64,
    pub gc_num_epochs_to_keep: u64,
    pub gc_step_period: DurationAsStdSchemaProvider,
}

Configuration for garbage collection.

JSON schema

{
 "description": "Configuration for garbage collection.",
 "type": "object",
 "properties": {
   "gc_blocks_limit": {
     "description": "Maximum number of blocks to garbage collect at every garbage collection\n call.",
     "default": 2,
     "type": "integer",
     "format": "uint64",
     "minimum": 0.0
   },
   "gc_fork_clean_step": {
     "description": "Maximum number of height to go through at each garbage collection step\n when cleaning forks during garbage collection.",
     "default": 100,
     "type": "integer",
     "format": "uint64",
     "minimum": 0.0
   },
   "gc_num_epochs_to_keep": {
     "description": "Number of epochs for which we keep store data.",
     "default": 5,
     "type": "integer",
     "format": "uint64",
     "minimum": 0.0
   },
   "gc_step_period": {
     "description": "How often gc should be run",
     "default": {
       "nanos": 0,
       "secs": 1
     },
     "allOf": [
       {
         "$ref": "#/components/schemas/DurationAsStdSchemaProvider"
       }
     ]
   }
 }
}

Fields

gc_blocks_limit: u64

Maximum number of blocks to garbage collect at every garbage collection call.

gc_fork_clean_step: u64

Maximum number of height to go through at each garbage collection step when cleaning forks during garbage collection.

gc_num_epochs_to_keep: u64

Number of epochs for which we keep store data.

gc_step_period: DurationAsStdSchemaProvider

How often gc should be run

Trait Implementations

impl Clone for GcConfig

fn clone(&self) -> GcConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GcConfig

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

Formats the value using the given formatter.

impl Default for GcConfig

fn default() -> GcConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GcConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<GcConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&GcConfig> for GcConfig

fn from(value: &GcConfig) -> GcConfig

Converts to this type from the input type.

impl Serialize for GcConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.