Struct IterativeCalculationSettings 

pub struct IterativeCalculationSettings {
    pub max_iterations: Option<i64>,
    pub convergence_threshold: Option<f64>,
}

A workbook’s iterative-calculation settings (iterativeCalculationSettings).

Sheets has no boolean “enabled” field: this object’s mere presence on SpreadsheetProperties is what turns iterative calculation on, and its absence is what turns it off. update-workbook-properties --iterative-calculation off therefore clears the field entirely (an absent key in the field-masked request, via SpreadsheetPropertiesUpdate::iterative_calculation_settings) rather than writing some “disabled” value into it — there is no such value.

Turning iterative calculation on changes what a circular-reference formula elsewhere in the workbook evaluates to: a value effect reached indirectly, the same shape of concern ADR-0081 raised for named-range deletion. It is still gated as sheets-structure rather than a data- mutating operation, because — like a named-range deletion — no cell’s formula is itself changed, only what some formulas compute (issue #1836, ADR-0086 §9).

PartialEq-only, not Eq: convergence_threshold is an f64.

Fields

max_iterations: Option<i64>

Maximum number of calculation rounds per recalculation. Omitted in a request takes Sheets’ own default.

convergence_threshold: Option<f64>

The maximum change between two consecutive rounds that still counts as converged. Omitted in a request takes Sheets’ own default.

Implementations

impl IterativeCalculationSettings

pub fn describe_bounds(&self) -> String

A human-readable qualifier for whichever bounds are set, e.g. " (max 50 iterations, threshold 0.01)" — empty (not just the bounds omitted) when both take Sheets’ own default. The leading space lets every call site append it directly after "on".

Shared by update-workbook-properties’s dry-run preview and real-run confirmation (structure.rs::workbook_properties_summary) and sheets info’s table render, so the two can never describe the same settings differently.

Trait Implementations

impl Clone for IterativeCalculationSettings

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for IterativeCalculationSettings

impl Debug for IterativeCalculationSettings

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

Formats the value using the given formatter.

impl Default for IterativeCalculationSettings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IterativeCalculationSettings

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for IterativeCalculationSettings

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for IterativeCalculationSettings

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for IterativeCalculationSettings