Enum BindValue 

#[non_exhaustive]
pub enum BindValue {
    Null,
    TypedNull {
        ora_type_num: u8,
        csfrm: u8,
        buffer_size: u32,
    },
    Output {
        ora_type_num: u8,
        csfrm: u8,
        buffer_size: u32,
    },
    ReturnOutput {
        ora_type_num: u8,
        csfrm: u8,
        buffer_size: u32,
    },
    ObjectOutput {
        schema: String,
        type_name: String,
        oid: Vec<u8>,
        version: u32,
        buffer_size: u32,
        is_return: bool,
    },
    ObjectInput {
        schema: String,
        type_name: String,
        oid: Vec<u8>,
        version: u32,
        image: Vec<u8>,
        buffer_size: u32,
    },
    Text(String),
    Raw(Vec<u8>),
    Lob {
        ora_type_num: u8,
        csfrm: u8,
        locator: Vec<u8>,
    },
    Number(String),
    BinaryInteger(String),
    BinaryDouble(f64),
    BinaryFloat(f64),
    Boolean(bool),
    IntervalDS {
        days: i32,
        seconds: i32,
        microseconds: i32,
    },
    IntervalYM {
        years: i32,
        months: i32,
    },
    DateTime {
        year: i32,
        month: u8,
        day: u8,
        hour: u8,
        minute: u8,
        second: u8,
    },
    Timestamp {
        ora_type_num: u8,
        year: i32,
        month: u8,
        day: u8,
        hour: u8,
        minute: u8,
        second: u8,
        nanosecond: u32,
    },
    TimestampTz {
        year: i32,
        month: u8,
        day: u8,
        hour: u8,
        minute: u8,
        second: u8,
        nanosecond: u32,
        offset_minutes: i32,
    },
    Array {
        ora_type_num: u8,
        csfrm: u8,
        buffer_size: u32,
        max_elements: u32,
        values: Vec<Option<BindValue>>,
    },
    Vector(Vector),
    Json(Vec<u8>),
    Cursor {
        cursor_id: u32,
    },
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Null

TypedNull

Fields

ora_type_num: u8

csfrm: u8

buffer_size: u32

Output

Fields

ora_type_num: u8

csfrm: u8

buffer_size: u32

ReturnOutput

Fields

ora_type_num: u8

csfrm: u8

buffer_size: u32

ObjectOutput

Fields

schema: String

type_name: String

oid: Vec<u8>

version: u32

buffer_size: u32

is_return: bool

ObjectInput

A DbObject bound as IN (or IN/OUT). The fully packed pickle image is built by the pyshim (it owns the recursive Python attribute values); the protocol only frames it (toid/oid/snapshot/version/len/flags + image).

Fields

schema: String

type_name: String

oid: Vec<u8>

version: u32

image: Vec<u8>

buffer_size: u32

Text(String)

Raw(Vec<u8>)

Lob

Fields

ora_type_num: u8

csfrm: u8

locator: Vec<u8>

Number(String)

BinaryInteger(String)

BinaryDouble(f64)

BinaryFloat(f64)

Boolean(bool)

IntervalDS

Fields

days: i32

seconds: i32

microseconds: i32

IntervalYM

Fields

years: i32

months: i32

DateTime

Fields

year: i32

month: u8

day: u8

hour: u8

minute: u8

second: u8

Timestamp

Fields

ora_type_num: u8

year: i32

month: u8

day: u8

hour: u8

minute: u8

second: u8

nanosecond: u32

TimestampTz

Fields

year: i32

month: u8

day: u8

hour: u8

minute: u8

second: u8

nanosecond: u32

offset_minutes: i32

Array

Fields

ora_type_num: u8

csfrm: u8

buffer_size: u32

max_elements: u32

values: Vec<Option<BindValue>>

Vector(Vector)

Json(Vec<u8>)

Native Oracle JSON bind (DB_TYPE_JSON): the already-encoded OSON image. The Python-facing layer encodes the value to OSON before binding so the connection’s long-field-name capability can be applied.

Cursor

Fields

cursor_id: u32

Implementations

impl BindValue

pub fn variant_name(&self) -> &'static str

A short, stable name for this value’s variant (e.g. "Text", "Number"). Lets callers identify a bind’s shape for logging / diagnostics without an exhaustive match that would break the moment a variant is added. The match lives inside the defining crate, so it remains the single exhaustiveness tripwire that flags a new variant at compile time.

pub fn is_null(&self) -> bool

Whether this bind is a plain SQL NULL (BindValue::Null). The typed NULL placeholder (BindValue::TypedNull) is not considered null by this accessor — it carries a concrete Oracle type for the server.

pub fn as_str(&self) -> Option<&str>

Borrow the string of a BindValue::Text bind, otherwise None. Convenience accessor so callers can read text binds without matching the full enum.

pub fn as_bytes(&self) -> Option<&[u8]>

Borrow the bytes of a BindValue::Raw bind, otherwise None.

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

Return the boolean of a BindValue::Boolean bind, otherwise None.

pub fn as_number_text(&self) -> Option<&str>

Borrow the canonical decimal text of a BindValue::Number or BindValue::BinaryInteger bind (both carry their value as decimal text), otherwise None.

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

Interpret this bind as an f64. Works for BindValue::BinaryDouble / BindValue::BinaryFloat (carried as f64), and for the decimal-text BindValue::Number / BindValue::BinaryInteger binds when the text parses. Returns None for any other variant. Models the reference shim’s own numeric read of a bound vector element (convert.rs).

pub fn as_i64(&self) -> Option<i64>

Interpret this bind as an i64. Works for the decimal-text BindValue::Number / BindValue::BinaryInteger binds when the text parses as an integer, and for BindValue::Boolean (true -> 1, false -> 0). Returns None otherwise.

Trait Implementations

impl Clone for BindValue

fn clone(&self) -> BindValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BindValue

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

Formats the value using the given formatter.

impl PartialEq for BindValue

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for BindValue