Struct rsfbclient_rust::RustFbClient

pub struct RustFbClient { /* private fields */ }

Firebird client implemented in pure rust

Implementations

impl RustFbClient

pub fn new(charset: Charset) -> Self

Construct a new instance of the pure rust client

Trait Implementations

impl FirebirdClientDbOps for RustFbClient

type DbHandle = DbHandle

A database handle

type AttachmentConfig = RustFbClientAttachmentConfig

Configuration details for attaching to the database. A user of an implementation of this trait can configure attachment details (database name, user name, etcetera) and then pass this configuration to the implementation via this type when a new attachment is requested

fn attach_database(
    &mut self,
    config: &Self::AttachmentConfig
) -> Result<DbHandle, FbError>

Create a new attachment to a database with the provided configuration Returns a database handle on success

fn detach_database(&mut self, db_handle: &mut DbHandle) -> Result<(), FbError>

Disconnect from the database

fn drop_database(&mut self, db_handle: &mut DbHandle) -> Result<(), FbError>

Drop the database

fn create_database(
    &mut self,
    config: &Self::AttachmentConfig,
    page_size: Option<u32>
) -> Result<DbHandle, FbError>

Create the database and attach Returns a database handle on success

impl FirebirdClientSqlOps for RustFbClient

type DbHandle = DbHandle

A database handle

type TrHandle = TrHandle

A transaction handle

type StmtHandle = StmtHandleData

A statement handle

fn begin_transaction(
    &mut self,
    db_handle: &mut Self::DbHandle,
    confs: TransactionConfiguration
) -> Result<Self::TrHandle, FbError>

Start a new transaction, with the specified transaction parameter buffer

fn transaction_operation(
    &mut self,
    tr_handle: &mut Self::TrHandle,
    op: TrOp
) -> Result<(), FbError>

Commit / Rollback a transaction

fn exec_immediate(
    &mut self,
    _db_handle: &mut Self::DbHandle,
    tr_handle: &mut Self::TrHandle,
    dialect: Dialect,
    sql: &str
) -> Result<(), FbError>

Execute a sql immediately, without returning rows

fn prepare_statement(
    &mut self,
    db_handle: &mut Self::DbHandle,
    tr_handle: &mut Self::TrHandle,
    dialect: Dialect,
    sql: &str
) -> Result<(StmtType, Self::StmtHandle), FbError>

Allocate and prepare a statement Returns the statement type and handle

fn free_statement(
    &mut self,
    stmt_handle: &mut Self::StmtHandle,
    op: FreeStmtOp
) -> Result<(), FbError>

Closes or drops a statement

fn execute(
    &mut self,
    _db_handle: &mut Self::DbHandle,
    tr_handle: &mut Self::TrHandle,
    stmt_handle: &mut Self::StmtHandle,
    params: Vec<SqlType>
) -> Result<usize, FbError>

Execute the prepared statement with parameters and returns the affected rows count

fn execute2(
    &mut self,
    _db_handle: &mut Self::DbHandle,
    tr_handle: &mut Self::TrHandle,
    stmt_handle: &mut Self::StmtHandle,
    params: Vec<SqlType>
) -> Result<Vec<Column>, FbError>

Execute the prepared statement with input and output parameters.

fn fetch(
    &mut self,
    _db_handle: &mut Self::DbHandle,
    tr_handle: &mut Self::TrHandle,
    stmt_handle: &mut Self::StmtHandle
) -> Result<Option<Vec<Column>>, FbError>

Fetch rows from the executed statement, coercing the types according to the provided blr