Expand description
Callback-borrowed Excel values that cannot outlive their issuing callback. Read-only views over values supplied by Excel for one callback invocation.
The only entry point from the raw ABI is RawExcelValue::from_callback.
It is unsafe because Rust cannot prove the validity or lifetime of the
pointer-bearing members of an XLOPER12. Once that boundary has been
audited by the callback thunk, decoding and observation are safe.
Callback views cannot be sent to another thread:
ⓘ
use excel_api::RawExcelValue;
fn require_send<T: Send>() {}
require_send::<RawExcelValue<'static>>();Nor can their callback lifetime be extended:
ⓘ
use excel_api::{ExcelValueRef, RawExcelValue};
fn escape(raw: &RawExcelValue<'_>) -> ExcelValueRef<'static> {
raw.decode().unwrap()
}Structs§
- Excel
Array Columns - Iterator over an array’s columns.
- Excel
Array Elements - Elements in one row or column of an Excel array.
- Excel
Array Rows - Iterator over an array’s rows.
- Excel
Array View - A flat row-major
xltypeMultiview. - Excel
Missing - Marker for an omitted function argument (
xltypeMissing). - Excel
Multi Reference - An explicit-sheet, one-or-more-area
xltypeRef. - Excel
Nil - Marker for an empty Excel value (
xltypeNil). - Excel
Reference Area - One rectangular area within a reference.
- Excel
Reference Areas - Iterator over the areas of an
xltypeRef. - Excel
Single Reference - An inline, current-sheet
xltypeSRef. - Excel
Str - Borrowed UTF-16 code units. No Unicode conversion is performed.
- RawExcel
Value - An
XLOPER12whose storage is owned by Excel for one callback invocation.
Enums§
- Decode
Error - Why a raw callback value could not be represented as a safe borrowed view.
- Excel
Reference - A reference-preserving callback value.
- Excel
Value Ref - A decoded, read-only Excel callback value.