Trait Descriptor 

pub trait Descriptor<'buf, DT, V: OdbcVersion>: Handle {
    // Provided methods
    fn SQLCopyDesc<DT2: DescType<'buf>>(
        &self,
        TargetDescHandle: &SQLHDESC<'_, DT2, V>,
    ) -> SQLRETURN { ... }
    fn SQLGetDescFieldA<A: Ident<Type = SQLSMALLINT>, T>(
        &self,
        RecNumber: SQLSMALLINT,
        FieldIdentifier: A,
        ValuePtr: Option<&mut T>,
        StringLengthPtr: Option<&mut MaybeUninit<T::StrLen>>,
    ) -> SQLRETURN
       where T: AttrGet<A> + Ansi + ?Sized + DescField<'buf, Self, DT, A, V>,
             MaybeUninit<T::StrLen>: StrLen<SQLINTEGER> { ... }
    fn SQLGetDescFieldW<A: Ident<Type = SQLSMALLINT>, T>(
        &self,
        RecNumber: SQLSMALLINT,
        FieldIdentifier: A,
        ValuePtr: Option<&mut T>,
        StringLengthPtr: Option<&mut MaybeUninit<T::StrLen>>,
    ) -> SQLRETURN
       where T: AttrGet<A> + Unicode + ?Sized + DescField<'buf, Self, DT, A, V>,
             MaybeUninit<T::StrLen>: StrLen<SQLINTEGER> { ... }
    fn SQLGetDescRecA<ST: SqlType<V>>(
        &self,
        RecNumber: SQLSMALLINT,
        Name: Option<&mut OdbcStr<MaybeUninit<SQLCHAR>>>,
        StringLengthPtr: &mut impl AsMutPtr<SQLSMALLINT>,
        TypePtr: &mut impl AsMutPtr<ST>,
        SubTypePtr: &mut impl AsMutPtr<DatetimeIntervalCode>,
        LengthPtr: &mut impl AsMutPtr<SQLLEN>,
        PrecisionPtr: &mut impl AsMutPtr<SQLSMALLINT>,
        ScalePtr: &mut impl AsMutPtr<SQLSMALLINT>,
        NullablePtr: &mut impl AsMutPtr<NullAllowed>,
    ) -> SQLRETURN { ... }
    fn SQLGetDescRecW<ST: SqlType<V>>(
        &self,
        RecNumber: SQLSMALLINT,
        Name: Option<&mut OdbcStr<MaybeUninit<SQLWCHAR>>>,
        StringLengthPtr: &mut impl AsMutPtr<SQLSMALLINT>,
        TypePtr: &mut impl AsMutPtr<ST>,
        SubTypePtr: &mut impl AsMutPtr<DatetimeIntervalCode>,
        LengthPtr: &mut impl AsMutPtr<SQLLEN>,
        PrecisionPtr: &mut impl AsMutPtr<SQLSMALLINT>,
        ScalePtr: &mut impl AsMutPtr<SQLSMALLINT>,
        NullablePtr: &mut impl AsMutPtr<NullAllowed>,
    ) -> SQLRETURN { ... }
    fn SQLSetDescFieldA<A: Ident<Type = SQLSMALLINT>, T>(
        &self,
        RecNumber: SQLSMALLINT,
        FieldIdentifier: A,
        ValuePtr: Option<T>,
    ) -> SQLRETURN
       where T: AttrSet<A> + Ansi + DescField<'buf, Self, DT, A, V> { ... }
    fn SQLSetDescFieldW<A: Ident<Type = SQLSMALLINT>, T>(
        &self,
        RecNumber: SQLSMALLINT,
        FieldIdentifier: A,
        ValuePtr: Option<T>,
    ) -> SQLRETURN
       where T: AttrSet<A> + Unicode + DescField<'buf, Self, DT, A, V> { ... }
    fn SQLSetDescRec<ST: SqlType<V>, PTR>(
        &self,
        RecNumber: SQLSMALLINT,
        Type: ST,
        SubType: Option<DatetimeIntervalCode>,
        Length: SQLLEN,
        Precision: SQLSMALLINT,
        Scale: SQLSMALLINT,
        DataPtr: Option<&'buf PTR>,
        StringLengthPtr: &'buf mut impl AsMutPtr<SQLLEN>,
        IndicatorPtr: &'buf mut impl AsMutPtr<SQLLEN>,
    ) -> SQLRETURN
       where &'buf PTR: IntoSQLPOINTER { ... }
}

Provided Methods

fn SQLCopyDesc<DT2: DescType<'buf>>( &self, TargetDescHandle: &SQLHDESC<'_, DT2, V>, ) -> SQLRETURN

Copies descriptor information from one descriptor handle to another.

For complete documentation on SQLCopyDesc, see API reference.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE.

fn SQLGetDescFieldA<A: Ident<Type = SQLSMALLINT>, T>( &self, RecNumber: SQLSMALLINT, FieldIdentifier: A, ValuePtr: Option<&mut T>, StringLengthPtr: Option<&mut MaybeUninit<T::StrLen>>, ) -> SQLRETURN

where T: AttrGet<A> + Ansi + ?Sized + DescField<'buf, Self, DT, A, V>, MaybeUninit<T::StrLen>: StrLen<SQLINTEGER>,

Returns the current setting or value of a single field of a descriptor record.

For complete documentation on SQLGetDescFieldA, see API reference.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, SQL_NO_DATA, or SQL_INVALID_HANDLE.

fn SQLGetDescFieldW<A: Ident<Type = SQLSMALLINT>, T>( &self, RecNumber: SQLSMALLINT, FieldIdentifier: A, ValuePtr: Option<&mut T>, StringLengthPtr: Option<&mut MaybeUninit<T::StrLen>>, ) -> SQLRETURN

where T: AttrGet<A> + Unicode + ?Sized + DescField<'buf, Self, DT, A, V>, MaybeUninit<T::StrLen>: StrLen<SQLINTEGER>,

Returns the current setting or value of a single field of a descriptor record.

For complete documentation on SQLGetDescFieldW, see API reference.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, SQL_NO_DATA, or SQL_INVALID_HANDLE.

fn SQLGetDescRecA<ST: SqlType<V>>( &self, RecNumber: SQLSMALLINT, Name: Option<&mut OdbcStr<MaybeUninit<SQLCHAR>>>, StringLengthPtr: &mut impl AsMutPtr<SQLSMALLINT>, TypePtr: &mut impl AsMutPtr<ST>, SubTypePtr: &mut impl AsMutPtr<DatetimeIntervalCode>, LengthPtr: &mut impl AsMutPtr<SQLLEN>, PrecisionPtr: &mut impl AsMutPtr<SQLSMALLINT>, ScalePtr: &mut impl AsMutPtr<SQLSMALLINT>, NullablePtr: &mut impl AsMutPtr<NullAllowed>, ) -> SQLRETURN

Returns the current settings or values of multiple fields of a descriptor record. The fields returned describe the name, data type, and storage of column or parameter data.

For complete documentation on SQLGetDescRecA, see API reference.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, SQL_NO_DATA, or SQL_INVALID_HANDLE.

fn SQLGetDescRecW<ST: SqlType<V>>( &self, RecNumber: SQLSMALLINT, Name: Option<&mut OdbcStr<MaybeUninit<SQLWCHAR>>>, StringLengthPtr: &mut impl AsMutPtr<SQLSMALLINT>, TypePtr: &mut impl AsMutPtr<ST>, SubTypePtr: &mut impl AsMutPtr<DatetimeIntervalCode>, LengthPtr: &mut impl AsMutPtr<SQLLEN>, PrecisionPtr: &mut impl AsMutPtr<SQLSMALLINT>, ScalePtr: &mut impl AsMutPtr<SQLSMALLINT>, NullablePtr: &mut impl AsMutPtr<NullAllowed>, ) -> SQLRETURN

Returns the current settings or values of multiple fields of a descriptor record. The fields returned describe the name, data type, and storage of column or parameter data.

For complete documentation on SQLGetDescRecW, see API reference.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, SQL_NO_DATA, or SQL_INVALID_HANDLE.

fn SQLSetDescFieldA<A: Ident<Type = SQLSMALLINT>, T>( &self, RecNumber: SQLSMALLINT, FieldIdentifier: A, ValuePtr: Option<T>, ) -> SQLRETURN

where T: AttrSet<A> + Ansi + DescField<'buf, Self, DT, A, V>,

Sets the value of a single field of a descriptor record.

For complete documentation on SQLSetDescFieldA, see API reference.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE.

fn SQLSetDescFieldW<A: Ident<Type = SQLSMALLINT>, T>( &self, RecNumber: SQLSMALLINT, FieldIdentifier: A, ValuePtr: Option<T>, ) -> SQLRETURN

where T: AttrSet<A> + Unicode + DescField<'buf, Self, DT, A, V>,

Sets the value of a single field of a descriptor record.

For complete documentation on SQLSetDescFieldW, see API reference.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE.

fn SQLSetDescRec<ST: SqlType<V>, PTR>( &self, RecNumber: SQLSMALLINT, Type: ST, SubType: Option<DatetimeIntervalCode>, Length: SQLLEN, Precision: SQLSMALLINT, Scale: SQLSMALLINT, DataPtr: Option<&'buf PTR>, StringLengthPtr: &'buf mut impl AsMutPtr<SQLLEN>, IndicatorPtr: &'buf mut impl AsMutPtr<SQLLEN>, ) -> SQLRETURN

where &'buf PTR: IntoSQLPOINTER,

Sets multiple descriptor fields that affect the data type and buffer bound to a column or parameter data.

For complete documentation on SQLSetDescRec, see API reference.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_ERROR, or SQL_INVALID_HANDLE.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<'conn, 'buf, DT: DescType<'buf>, V: OdbcVersion> Descriptor<'buf, DT, V> for RefSQLHDESC<'conn, DT, V>

impl<'conn, 'buf, DT: DescType<'buf>, V: OdbcVersion> Descriptor<'buf, DT, V> for RefUnsafeSQLHDESC<'conn, DT, V>

impl<'conn, 'buf, DT: DescType<'buf>, V: OdbcVersion> Descriptor<'buf, DT, V> for SQLHDESC<'conn, DT, V>

impl<'conn, 'buf, DT: DescType<'buf>, V: OdbcVersion> Descriptor<'buf, DT, V> for UnsafeSQLHDESC<'conn, DT, V>