Enum odbc_api::handles::SqlResult

pub enum SqlResult<T> {
    Success(T),
    SuccessWithInfo(T),
    NoData,
    NeedData,
    StillExecuting,
    Error {
        function: &'static str,
    },
}

Result of an ODBC function call. Variants hold the same meaning as the constants associated with SqlReturn. This type may hold results, but it is still the responsibility of the user to fetch and handle the diagnostics in case of an Error.

Variants

Success(T)

The function has been executed successfully.

SuccessWithInfo(T)

The function has been executed successfully. There have been warnings.

NoData

Meaning depends on the function emitting NoData.

NeedData

Emmitted by execute in case delayed parameters have been bound and their input values are now required.

StillExecuting

The function was started asynchronously and is still executing.

Error

Fields

function: &'static str

Name of the ODBC Api call which caused the error. This might help interpreting associatedif the error ODBC diagnostics if the error is bubbeld all the way up to the end users output, but the context is lost.

The function returned an error state. Check diagnostics.

Implementations

impl SqlResult<()>

pub fn into_result_bool(self, handle: &impl Diagnostics) -> Result<bool, Error>

Use this instead of Self::into_result if you expect SqlResult::NoData to be a valid value. SqlResult::NoData is mapped to Ok(false), all other success values are Ok(true).

impl<T> SqlResult<T>

pub fn into_result(self, handle: &impl Diagnostics) -> Result<T, Error>

Self::Success and Self::SuccessWithInfo are mapped to Ok. In case of Self::SuccessWithInfo any diagnostics are logged. Self::Error is mapped to error.

pub fn into_result_option(
    self,
    handle: &impl Diagnostics
) -> Result<Option<T>, Error>

Like Self::into_result, but SqlResult::NoData is mapped to None, and any success is mapped to Some.

pub fn into_result_with(
    self,
    handle: &impl Diagnostics,
    error_for_truncation: bool,
    no_data: Option<T>,
    need_data: Option<T>
) -> Result<T, Error>

Most flexible way of converting an SqlResult to an idiomatic Result.

Parameters

• handle: This handle is used to extract diagnostics in case self is SqlResult::SuccessWithInfo or SqlResult::Error.
• error_for_truncation: Intended to be used to be used after bulk fetching into a buffer. If error_for_truncation is true any diagnostics are inspected for truncation. If any truncation is found an error is returned.
• no_data: Controls the behaviour for SqlResult::NoData. None indicates that the result is never expected to be SqlResult::NoData and would panic in that case. Some(value) would cause SqlResult::NoData to be mapped to Ok(value).
• need_data: Controls the behaviour for SqlResult::NeedData. None indicates that the result is never expected to be SqlResult::NeedData and would panic in that case. Some(value) would cause SqlResult::NeedData to be mapped to Ok(value).

impl SqlResult<()>

pub fn on_success<F, T>(self, f: F) -> SqlResult<T>where
    F: FnOnce() -> T,

Append a return value a successful to Result

impl<T> SqlResult<T>

pub fn is_err(&self) -> bool

True if variant is SqlResult::Error.

pub fn map<U, F>(self, f: F) -> SqlResult<U>where
    F: FnOnce(T) -> U,

Applies f to any value wrapped in Success or SuccessWithInfo.

pub fn unwrap(self) -> T

Trait Implementations

impl<T: Clone> Clone for SqlResult<T>

fn clone(&self) -> SqlResult<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SqlResult<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq<SqlResult<T>> for SqlResult<T>

fn eq(&self, other: &SqlResult<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Copy> Copy for SqlResult<T>

impl<T: Eq> Eq for SqlResult<T>

impl<T> StructuralEq for SqlResult<T>

impl<T> StructuralPartialEq for SqlResult<T>