Skip to main content

VdbeProgram

Struct VdbeProgram 

Source
pub struct VdbeProgram { /* private fields */ }
Expand description

A finalized VDBE bytecode program ready for execution.

Implementations§

Source§

impl VdbeProgram

Source

pub fn route_storage_roots_to_temp_database( &mut self, temp_roots: impl IntoIterator<Item = i32>, )

Route storage-root opens for connection-local TEMP objects through SQLite’s database-number 1 namespace.

Code generation deliberately operates on schema metadata rather than connection state, so it cannot know which otherwise ordinary table roots belong to the TEMP database. The connection applies this final annotation after codegen. Execution then uses the attached MemDatabase instead of ever consulting or mutating pages in the main pager.

Source

pub fn ops(&self) -> &[VdbeOp]

The instruction sequence.

Source

pub fn len(&self) -> usize

Number of instructions.

Source

pub fn is_empty(&self) -> bool

Whether the program is empty.

Source

pub fn register_count(&self) -> i32

Number of registers required.

Source

pub fn max_bind_parameter_index(&self) -> Result<usize, i32>

Highest 1-based bind parameter index referenced by the program.

Returns Ok(0) when no Variable opcodes are present. Returns Err(raw_index) if the bytecode contains an invalid parameter index (<= 0 or not representable as usize).

Source

pub fn get(&self, pc: usize) -> Option<&VdbeOp>

Get the instruction at the given program counter.

Source

pub fn table_index_meta(&self) -> &HashMap<i32, Box<[IndexCursorMeta]>>

Table-to-index cursor metadata for REPLACE conflict resolution.

Source

pub fn storage_root_usages(&self) -> impl Iterator<Item = StorageRootUsage> + '_

Returns storage B-tree root usage in deterministic instruction order.

Conflict-topology and backend-identity diagnostics can use this to tie bytecode to root-page level heat without ad hoc opcode scans.

Source

pub fn has_insert_ops(&self) -> bool

Returns true if the program contains any Insert opcodes, meaning column defaults may be needed during execution. Precomputed at build time — O(1) at call time.

Source

pub fn requires_attached_memdb(&self) -> bool

Returns true when this program still requires an attached MemDatabase for opcode semantics.

Source

pub fn attached_memdb_requirement_reason(&self) -> Option<&'static str>

Returns the first conservative reason this program still requires an attached MemDatabase, or None for storage-only VDBE programs.

Source

pub fn requires_version_store(&self) -> bool

Returns true when this program can read historical page versions.

Source

pub fn disassemble(&self) -> String

Disassemble the program to a human-readable string.

Output format matches SQLite’s EXPLAIN output:

addr  opcode         p1    p2    p3    p4             p5
----  ----------     ----  ----  ----  -----          --
0     Init           0     8     0                    0

Trait Implementations§

Source§

impl Clone for VdbeProgram

Source§

fn clone(&self) -> VdbeProgram

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VdbeProgram

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for VdbeProgram

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for VdbeProgram

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more