RpcRequest

Struct RpcRequest 

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

RPC request builder.

Implementations§

Source§

impl RpcRequest

Source

pub fn named(proc_name: impl Into<String>) -> Self

Create a new RPC request for a named procedure.

Source

pub fn by_id(proc_id: ProcId) -> Self

Create a new RPC request for a well-known procedure.

Source

pub fn execute_sql(sql: &str, params: Vec<RpcParam>) -> Self

Create an sp_executesql request.

This is the primary method for parameterized queries.

§Example
use tds_protocol::rpc::{RpcRequest, RpcParam};

let rpc = RpcRequest::execute_sql(
    "SELECT * FROM users WHERE id = @p1 AND name = @p2",
    vec![
        RpcParam::int("@p1", 42),
        RpcParam::nvarchar("@p2", "Alice"),
    ],
);
Source

pub fn prepare(sql: &str, params: &[RpcParam]) -> Self

Create an sp_prepare request.

Source

pub fn execute(handle: i32, params: Vec<RpcParam>) -> Self

Create an sp_execute request.

Source

pub fn unprepare(handle: i32) -> Self

Create an sp_unprepare request.

Source

pub fn with_options(self, options: RpcOptionFlags) -> Self

Set option flags.

Source

pub fn param(self, param: RpcParam) -> Self

Add a parameter.

Source

pub fn encode(&self) -> Bytes

Encode the RPC request to bytes (auto-commit mode).

For requests within an explicit transaction, use Self::encode_with_transaction.

Source

pub fn encode_with_transaction(&self, transaction_descriptor: u64) -> Bytes

Encode the RPC request with a transaction descriptor.

Per MS-TDS spec, when executing within an explicit transaction:

  • The transaction_descriptor MUST be the value returned by the server in the BeginTransaction EnvChange token.
  • For auto-commit mode (no explicit transaction), use 0.
§Arguments
  • transaction_descriptor - The transaction descriptor from BeginTransaction EnvChange, or 0 for auto-commit mode.

Trait Implementations§

Source§

impl Clone for RpcRequest

Source§

fn clone(&self) -> RpcRequest

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RpcRequest

Source§

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

Formats the value using the given formatter. Read more

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<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, 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> 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.