Struct Footprint 

pub struct Footprint {

    pub executed: u64,
    pub param_bytes: u64,
    pub rolls_back: bool,
    pub log_full: bool,
    pub sheets: Vec<SheetFootprint>,
    pub sheets_added: Vec<String>,
    pub sheets_removed: Vec<String>,
    pub objects_added: usize,
    pub objects_changed: usize,
    pub objects_removed: usize,
    pub partial: Option<Value>,
    pub error: Option<StepError>,
    pub stopped: Option<String>,
}

What a macro would change, from a dry run on the real workbook.

Fields

executed: u64

Steps executed and bytes of parameters passed by the end of the dry run that made this footprint (the run’s one budget).

param_bytes: u64

rolls_back: bool

The Stop step that ended the dry run asks for the run to be rolled back.

log_full: bool

The dry run wrote more cells than the touch log keeps, so writes that kept a cell’s value may be missing from cells: a shift cannot trust the block.

sheets: Vec<SheetFootprint>

sheets_added: Vec<String>

sheets_removed: Vec<String>

objects_added: usize

objects_changed: usize

objects_removed: usize

partial: Option<Value>

The dry run stopped early before this step; later steps aren’t in the footprint.

error: Option<StepError>

The step the run would fail at.

stopped: Option<String>

A Stop step’s message.

Implementations

impl Footprint

pub fn conflict_count(&self) -> usize

Cells that hold data and would be written, plus sheets and objects that would go.

pub fn describe_conflicts(&self) -> String

“C2:C9 on Sheet1, the sheet Old, 2 objects”.

Trait Implementations

impl Clone for Footprint

fn clone(&self) -> Footprint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Footprint

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

Formats the value using the given formatter.

impl Default for Footprint

fn default() -> Footprint

Returns the “default value” for a type.

impl Serialize for Footprint

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

where __S: Serializer,

Serialize this value into the given Serde serializer.