Struct CApi

pub struct CApi { /* private fields */ }

Implementations

impl CApi

pub fn sqlite3_open_v2( &self, filename: JsValue, ppDb: *mut *mut sqlite3, flags: c_int, vfs: JsValue, ) -> c_int

impl CApi

pub fn sqlite3_close_v2(&self, db: *mut sqlite3) -> c_int

impl CApi

pub fn sqlite3_exec( &self, ab: *mut sqlite3, sql: JsValue, callback: Option<&Closure<dyn FnMut(Vec<String>, Vec<String>) -> c_int>>, pCbArg: *mut c_void, pzErrMsg: *mut *mut c_char, ) -> c_int

impl CApi

pub fn sqlite3_changes(&self, db: *mut sqlite3) -> c_int

impl CApi

pub fn sqlite3_errmsg(&self, db: *mut sqlite3) -> String

impl CApi

pub fn sqlite3_serialize( &self, db: *mut sqlite3, schema: JsValue, piSize: *mut sqlite3_int64, flags: c_uint, ) -> *mut c_uchar

impl CApi

pub fn sqlite3_free(&self, ptr: *mut c_void)

impl CApi

pub fn sqlite3_create_function_v2( &self, db: *mut sqlite3, functionName: JsValue, nArg: c_int, eTextRep: c_int, pApp: *mut c_void, xFunc: Option<&Closure<dyn FnMut(*mut sqlite3_context, c_int, *mut *mut sqlite3_value)>>, xStep: Option<&Closure<dyn FnMut(*mut sqlite3_context, c_int, *mut *mut sqlite3_value)>>, xFinal: Option<&Closure<dyn FnMut(*mut sqlite3_context)>>, xDestroy: Option<&Closure<dyn FnMut()>>, ) -> c_int

impl CApi

pub fn sqlite3_result_text( &self, ctx: *mut sqlite3_context, text: JsValue, textLen: c_int, dtor: c_int, )

impl CApi

pub fn sqlite3_result_blob( &self, ctx: *mut sqlite3_context, blob: *const c_void, blobLen: c_int, dtor: c_int, )

impl CApi

pub fn sqlite3_result_int(&self, ctx: *mut sqlite3_context, value: c_int)

impl CApi

pub fn sqlite3_result_int64( &self, ctx: *mut sqlite3_context, value: sqlite3_int64, )

impl CApi

pub fn sqlite3_result_double(&self, ctx: *mut sqlite3_context, value: f64)

impl CApi

pub fn sqlite3_result_null(&self, ctx: *mut sqlite3_context)

impl CApi

pub fn sqlite3_column_value( &self, stmt: *mut sqlite3_stmt, colIdx: c_int, ) -> *mut sqlite3_value

impl CApi

pub fn sqlite3_column_count(&self, stmt: *mut sqlite3_stmt) -> c_int

impl CApi

pub fn sqlite3_column_name( &self, stmt: *mut sqlite3_stmt, colIdx: c_int, ) -> String

impl CApi

pub fn sqlite3_bind_null(&self, stmt: *mut sqlite3_stmt, idx: c_int)

impl CApi

pub fn sqlite3_bind_blob( &self, stmt: *mut sqlite3_stmt, idx: c_int, blob: *const c_void, n: c_int, dtor: c_int, ) -> c_int

impl CApi

pub fn sqlite3_bind_text( &self, stmt: *mut sqlite3_stmt, idx: c_int, text: *const c_char, n: c_int, dtor: c_int, ) -> c_int

impl CApi

pub fn sqlite3_value_free(&self, sqliteValue: *mut sqlite3_value)

impl CApi

pub fn sqlite3_value_text(&self, sqliteValue: *mut sqlite3_value) -> String

impl CApi

pub fn sqlite3_value_bytes(&self, sqliteValue: *mut sqlite3_value) -> c_int

impl CApi

pub fn sqlite3_value_blob( &self, sqliteValue: *mut sqlite3_value, ) -> *const c_void

impl CApi

pub fn sqlite3_value_int(&self, sqliteValue: *mut sqlite3_value) -> c_int

impl CApi

pub fn sqlite3_value_int64( &self, sqliteValue: *mut sqlite3_value, ) -> sqlite3_int64

impl CApi

pub fn sqlite3_value_double(&self, sqliteValue: *mut sqlite3_value) -> f64

impl CApi

pub fn sqlite3_value_type(&self, sqliteValue: *mut sqlite3_value) -> c_int

impl CApi

pub fn sqlite3_value_dup( &self, sqliteValue: *const sqlite3_value, ) -> *mut sqlite3_value

impl CApi

pub fn sqlite3_bind_double( &self, stmt: *mut sqlite3_stmt, idx: c_int, value: f64, ) -> c_int

impl CApi

pub fn sqlite3_bind_int( &self, stmt: *mut sqlite3_stmt, idx: c_int, value: c_int, ) -> c_int

impl CApi

pub fn sqlite3_bind_int64( &self, stmt: *mut sqlite3_stmt, idx: c_int, value: sqlite3_int64, ) -> c_int

impl CApi

pub fn sqlite3_create_collation_v2( &self, db: *mut sqlite3, zName: &str, eTextRep: c_int, pArg: *mut c_void, xCompare: Option<&Closure<dyn FnMut(*mut c_void, c_int, *const c_void, c_int, *const c_void) -> c_int>>, xDestroy: Option<&Closure<dyn FnMut(*mut c_void)>>, ) -> c_int

impl CApi

pub fn sqlite3_extended_errcode(&self, db: *mut sqlite3) -> c_int

impl CApi

pub fn sqlite3_finalize(&self, stmt: *mut sqlite3_stmt) -> c_int

impl CApi

pub fn sqlite3_step(&self, stmt: *mut sqlite3_stmt) -> c_int

impl CApi

pub fn sqlite3_db_handle(&self, stmt: *mut sqlite3_stmt) -> *mut sqlite3

impl CApi

pub fn sqlite3_reset(&self, stmt: *mut sqlite3_stmt) -> c_int

impl CApi

pub fn sqlite3_prepare_v3( &self, db: *mut sqlite3, sql: *const c_char, nByte: c_int, prepFlags: c_uint, ppStmt: *mut *mut sqlite3_stmt, pzTail: *mut *const c_char, ) -> c_int

impl CApi

pub fn sqlite3_deserialize( &self, db: *mut sqlite3, schema: JsValue, data: *mut c_uchar, dbSize: sqlite3_int64, bufferSize: sqlite3_int64, flags: c_uint, ) -> c_int

impl CApi

pub fn sqlite3_context_db_handle( &self, ctx: *mut sqlite3_context, ) -> *mut sqlite3

impl CApi

pub fn sqlite3_user_data(&self, ctx: *mut sqlite3_context) -> *mut c_void

impl CApi

pub fn sqlite3_aggregate_context( &self, ctx: *mut sqlite3_context, nBytes: c_int, ) -> *mut c_void

impl CApi

pub fn sqlite3_result_error( &self, ctx: *mut sqlite3_context, msg: JsValue, msgLen: c_int, )

Methods from Deref<Target = JsValue>

pub const NULL: JsValue

pub const UNDEFINED: JsValue

pub const TRUE: JsValue

pub const FALSE: JsValue

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

pub fn as_string(&self) -> Option<String>

If this JS value is a string value, this function copies the JS string value into Wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_array(&self) -> bool

Tests whether this JS value is an instance of Array.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

pub fn lt(&self, other: &JsValue) -> bool

Applies the binary < JS operator on the two JsValues.

MDN documentation

pub fn le(&self, other: &JsValue) -> bool

Applies the binary <= JS operator on the two JsValues.

MDN documentation

pub fn ge(&self, other: &JsValue) -> bool

Applies the binary >= JS operator on the two JsValues.

MDN documentation

pub fn gt(&self, other: &JsValue) -> bool

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl AsRef<CApi> for CApi

fn as_ref(&self) -> &CApi

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<JsValue> for CApi

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for CApi

type Target = JsValue

The resulting type after dereferencing.

fn deref(&self) -> &JsValue

Dereferences the value.

impl From<CApi> for JsValue

fn from(obj: CApi) -> JsValue

Converts to this type from the input type.

impl From<JsValue> for CApi

fn from(obj: JsValue) -> CApi

Converts to this type from the input type.

impl FromWasmAbi for CApi

type Abi = <JsValue as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl<'a> IntoWasmAbi for &'a CApi

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl IntoWasmAbi for CApi

type Abi = <JsValue as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsCast for CApi

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> bool

where T: JsCast,

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> T

where T: JsCast,

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> bool

where T: JsCast,

Test whether this JS value is an instance of the type T.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

impl LongRefFromWasmAbi for CApi

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = CApi

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for CApi

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl<'a> OptionIntoWasmAbi for &'a CApi

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl OptionIntoWasmAbi for CApi

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for CApi

type Abi = <JsValue as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<CApi>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl WasmDescribe for CApi

fn describe()