Struct CheckpointMetadata 

pub struct CheckpointMetadata {
    pub fingerprint: i64,
    pub identifier: Option<String>,
    pub processed_records: Option<i64>,
    pub size: Option<i64>,
    pub steps: Option<i64>,
    pub uuid: Uuid,
}

Holds meta-data about a checkpoint that was taken for persistent storage and recovery of a circuit’s state.

JSON schema

{
 "description": "Holds meta-data about a checkpoint that was taken for persistent storage\nand recovery of a circuit's state.",
 "type": "object",
 "required": [
   "fingerprint",
   "uuid"
 ],
 "properties": {
   "fingerprint": {
     "description": "Fingerprint of the circuit at the time of the checkpoint.",
     "type": "integer",
     "format": "int64",
     "minimum": 0.0
   },
   "identifier": {
     "description": "An optional name for the checkpoint.",
     "type": [
       "string",
       "null"
     ]
   },
   "processed_records": {
     "description": "Total number of records processed.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64",
     "minimum": 0.0
   },
   "size": {
     "description": "Total size of the checkpoint files in bytes.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64",
     "minimum": 0.0
   },
   "steps": {
     "description": "Total number of steps made.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int64",
     "minimum": 0.0
   },
   "uuid": {
     "description": "A unique identifier for the given checkpoint.\n\nThis is used to identify the checkpoint in the file-system hierarchy.",
     "type": "string",
     "format": "uuid"
   }
 }
}

Fields

fingerprint: i64

Fingerprint of the circuit at the time of the checkpoint.

identifier: Option<String>

An optional name for the checkpoint.

processed_records: Option<i64>

Total number of records processed.

size: Option<i64>

Total size of the checkpoint files in bytes.

steps: Option<i64>

Total number of steps made.

uuid: Uuid

A unique identifier for the given checkpoint.

This is used to identify the checkpoint in the file-system hierarchy.

Implementations

impl CheckpointMetadata

pub fn builder() -> CheckpointMetadata

Trait Implementations

impl Clone for CheckpointMetadata

fn clone(&self) -> CheckpointMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CheckpointMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CheckpointMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&CheckpointMetadata> for CheckpointMetadata

fn from(value: &CheckpointMetadata) -> Self

Converts to this type from the input type.

impl From<CheckpointMetadata> for CheckpointMetadata

fn from(value: CheckpointMetadata) -> Self

Converts to this type from the input type.

impl Serialize for CheckpointMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CheckpointMetadata> for CheckpointMetadata

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: CheckpointMetadata) -> Result<Self, ConversionError>

Performs the conversion.