Struct Outcome 

pub struct Outcome {
    pub command: String,
    pub columns: Vec<Column>,
    pub rows: Vec<Vec<Json>>,
    pub total: usize,
    pub more: bool,
    pub changes: i64,
    pub last_insert_rowid: i64,
    pub elapsed_ms: f64,
    pub text: String,
    pub extra: Vec<(String, Json)>,
}

What a command produced.

Fields

command: String

The verb that ran.

columns: Vec<Column>

The result columns, empty for a command that produces no table.

rows: Vec<Vec<Json>>

The rows, already cut to whatever limit was asked for.

total: usize

How many rows the statement produced before the limit.

more: bool

Whether the limit cut anything off.

changes: i64

How many rows the statement changed.

last_insert_rowid: i64

The rowid the last insert assigned.

elapsed_ms: f64

How long it took.

text: String

The rendering a person reads.

extra: Vec<(String, Json)>

Anything this particular command has to say that the shape above cannot.

Implementations

impl Outcome

pub fn said(command: &str, text: impl Into<String>) -> Outcome

Builds an outcome that is only a message.

@param command - the verb @param text - what to show

pub fn with(self, name: &str, value: Json) -> Outcome

Adds a field only this command has.

@param name - the member name @param value - what to put under it

pub fn with_recovery(self, recovery: &Recovery, strays: &[u64]) -> Outcome

Adds what opening the database did, when it did anything.

Only when something happened (task-1979, C10). A recovered member on every result of every command would change the envelope every caller parses and every page documents, to carry false almost always. An operator investigating a crash asks one question - was this file recovered - and the answer is the presence of the member.

A stray segment is reported the same way and for the same reason: it is a file beside the database that nothing will replay and nothing will remove, so naming it is the only way anybody finds out it is there.

@param recovery - what the open reported @param strays - segments beside the file the chain does not reach

pub fn to_json(&self) -> Json

Renders this outcome as the object every front end reports.

Trait Implementations

impl Clone for Outcome

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Outcome

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

Formats the value using the given formatter.