Struct RpcParam 

pub struct RpcParam {
    pub name: String,
    pub flags: ParamFlags,
    pub type_info: TypeInfo,
    pub value: Option<Bytes>,
    pub crypto_metadata: Option<EncryptedParamMetadata>,
}

An RPC parameter.

Fields

name: String

Parameter name (can be empty for positional params).

flags: ParamFlags

Status flags.

type_info: TypeInfo

Type information.

value: Option<Bytes>

Parameter value (raw bytes).

crypto_metadata: Option<EncryptedParamMetadata>

Always Encrypted cipher metadata, written after the value when the parameter is encrypted. None for ordinary parameters.

Implementations

impl RpcParam

pub fn new(name: impl Into<String>, type_info: TypeInfo, value: Bytes) -> Self

Create a new parameter with a value.

pub fn null(name: impl Into<String>, type_info: TypeInfo) -> Self

Create a NULL parameter.

pub fn encrypted( name: impl Into<String>, ciphertext: Bytes, metadata: EncryptedParamMetadata, ) -> Self

Create an Always Encrypted parameter.

ciphertext is the AEAD-encrypted, normalized value; metadata is the cipher info the server needs to validate and route it. On the wire the value is carried as BIGVARBINARY(max) with the fEncrypted status bit set and the EncryptedParamMetadata trailer after the value.

pub fn encrypted_null( name: impl Into<String>, metadata: EncryptedParamMetadata, ) -> Self

Create a NULL Always Encrypted parameter.

The server rejects a plaintext parameter bound to an encrypted column, even for NULL, so a NULL value is still sent encrypted: BIGVARBINARY(max) with the fEncrypted status bit, a NULL value, and the cipher metadata.

pub fn int(name: impl Into<String>, value: i32) -> Self

Create an INT parameter.

pub fn bigint(name: impl Into<String>, value: i64) -> Self

Create a BIGINT parameter.

pub fn nvarchar(name: impl Into<String>, value: &str) -> Self

Create an NVARCHAR parameter.

pub fn varchar(name: impl Into<String>, value: &str) -> Self

Create a VARCHAR parameter.

Encodes the string as single-byte characters using Windows-1252 encoding (when the encoding feature is enabled) or Latin-1 fallback. Characters not representable in the target encoding are replaced with ?.

Use this instead of nvarchar when SendStringParametersAsUnicode=false to allow SQL Server to use index seeks on VARCHAR columns.

pub fn varchar_with_collation( name: impl Into<String>, value: &str, collation: &Collation, ) -> Self

Create a VARCHAR parameter using the server’s collation for encoding.

Uses the collation’s character encoding instead of the default Windows-1252. For UTF-8 collations (SQL Server 2019+), the string bytes are used directly.

pub fn as_output(self) -> Self

Mark as output parameter.

pub fn encode(&self, buf: &mut BytesMut)

Encode the parameter to buffer.

Trait Implementations

impl Clone for RpcParam

fn clone(&self) -> RpcParam

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RpcParam

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

Formats the value using the given formatter.