Struct ActionEffect 

pub struct ActionEffect {

    pub version: u32,
    pub async_tasks: Vec<Task>,
    pub status: StatusCode,
    pub value_changed: Vec<SheetCellId>,
    pub cell_removed: Vec<SheetCellId>,
    pub style_changed: Vec<SheetCellId>,
    pub row_inserted: Vec<SheetRowId>,
    pub row_removed: Vec<SheetRowId>,
    pub row_updated: Vec<SheetRowId>,
    pub col_inserted: Vec<SheetColId>,
    pub col_removed: Vec<SheetColId>,
    pub col_updated: Vec<SheetColId>,
    pub header_updated: Vec<u32>,
    pub error_message: Option<String>,
}

ActionEffect represents the result of handling an EditAction.

Additionally, since LogiSheets allows developers to define their own functions, the engine may encounter functions it cannot compute directly. In such cases, the engine will return these tasks to the JavaScript side for further processing.

Fields

version: u32

The undo-history version after the action: it advances only when an undoable transaction is recorded. Undo, redo and rejections report 0. For change detection use Workbook::get_version (the revision).

async_tasks: Vec<Task>

Tasks should be calculated outside this engine(mainly because of network limitations and customer defined)

status: StatusCode

Err when the engine rejected the action. A rejection is reported here, not raised: callers that need the write to land must check it.

value_changed: Vec<SheetCellId>

Cells whose value changed, including recalculated dependents. Undo and redo swap whole snapshots and leave all the change lists empty, so a host must re-read everything after them.

cell_removed: Vec<SheetCellId>

style_changed: Vec<SheetCellId>

row_inserted: Vec<SheetRowId>

row_removed: Vec<SheetRowId>

row_updated: Vec<SheetRowId>

Never populated at present.

col_inserted: Vec<SheetColId>

col_removed: Vec<SheetColId>

col_updated: Vec<SheetColId>

Never populated at present.

header_updated: Vec<u32>

Sheet indices whose row-heights or column-widths changed. Lets the frontend re-render row/column headers (and any UI chrome whose position depends on row/column metrics) for those sheets without invalidating cell content.

error_message: Option<String>

Why the action failed, when status is Err. The status code is a placeholder — every rejection is code 1 — so this is the only part a caller can act on. A rejected transaction names and quotes the payload it stopped at.

Implementations

impl ActionEffect

pub fn rejected(reason: String) -> ActionEffect

pub fn from( version: u32, tasks: Vec<Task>, ty: WorkbookUpdateType, ) -> ActionEffect

Trait Implementations

impl Clone for ActionEffect

fn clone(&self) -> ActionEffect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActionEffect

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

Formats the value using the given formatter.

impl Default for ActionEffect

fn default() -> ActionEffect

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ActionEffect

fn deserialize<D>( deserializer: D, ) -> Result<ActionEffect, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<_GentsDummyActionEffect> for ActionEffect

fn from(value: _GentsDummyActionEffect) -> ActionEffect

Converts to this type from the input type.

impl Serialize for ActionEffect

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.

impl TS for ActionEffect

fn _register(manager: &mut DescriptorManager, generic_base: bool) -> usize

fn _ts_name() -> String

fn _is_optional() -> bool

fn _tag() -> Option<&'static str>