sibyl 0.7.0

An OCI-based (synchronous or asynchronous) interface between Rust applications and Oracle databases
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283

//! SQL statement arguments

mod num;
mod str;
mod string;
mod bin;
mod binvec;
mod bool;
pub(crate) mod nchar;

use super::bind::Params;
use crate::types::OracleDataType;
use crate::{oci::*, Result};
use std::cell::UnsafeCell;
use std::mem::size_of;

/// A trait for types that can be used as SQL arguments
pub trait ToSql : Send + Sync {
    /**
    Binds itself to the SQL parameter placeholder

    # Parameters

    - `pos` - zero-based index of the parameter placeholder to which the value will be bound
    - `params` - Statement parameters as defined in the SQL
    - `stmt` - statement to which the argument value will be bound
    - `err` - OCI error structure

    Note that the specified position might be ignored if the argument also provides the specific
    placeholder name to which the value should be bound.

    # Returns

    The index of the placeholder for the next argument.
    */
    fn bind_to(&mut self, pos: usize, params: &mut Params, stmt: &OCIStmt, err: &OCIError) -> Result<usize>;

    /**
    A callback that is called to update OUT (or INOUT) argument. For example, to set the length
    of the received data.
    */
    fn update_from_bind(&mut self, pos: usize, _params: &Params) -> Result<usize> {
        Ok(pos + 1)
    }
}

impl ToSql for () {
    fn bind_to(&mut self, pos: usize, _params: &mut Params, _stmt: &OCIStmt, _err: &OCIError) -> Result<usize> {
        Ok(pos + 1)
    }
}


impl<T> ToSql for Descriptor<T> where T: DescriptorType, T::OCIType: OCIStruct {
    fn bind_to(&mut self, pos: usize, params: &mut Params, stmt: &OCIStmt, err: &OCIError) -> Result<usize> {
        params.bind(pos, T::sql_type(), self.as_ptr() as _, size_of::<*mut T::OCIType>(), size_of::<*mut T::OCIType>(), stmt, err)?;
        Ok(pos + 1)
    }
}

impl<T> ToSql for &Descriptor<T> where T: DescriptorType, T::OCIType: OCIStruct {
    fn bind_to(&mut self, pos: usize, params: &mut Params, stmt: &OCIStmt, err: &OCIError) -> Result<usize> {
        params.bind(pos, T::sql_type(), self.as_ptr() as _, size_of::<*mut T::OCIType>(), size_of::<*mut T::OCIType>(), stmt, err)?;
        Ok(pos + 1)
    }
}

impl<T> ToSql for &mut Descriptor<T> where T: DescriptorType, T::OCIType: OCIStruct {
    fn bind_to(&mut self, pos: usize, params: &mut Params, stmt: &OCIStmt, err: &OCIError) -> Result<usize> {
        params.bind(pos, T::sql_type(), self.as_mut_ptr() as _, size_of::<*mut T::OCIType>(), size_of::<*mut T::OCIType>(), stmt, err)?;
        Ok(pos + 1)
    }
}

impl<T> ToSql for Option<T> where T: OracleDataType {
    fn bind_to(&mut self, pos: usize, params: &mut Params, stmt: &OCIStmt, err: &OCIError) -> Result<usize> {
        if let Some(val) = self {
            val.bind_to(pos, params, stmt, err)
        } else {
            params.bind_null(pos, T::sql_null_type(), stmt, err)?;
            Ok(pos + 1)
        }
    }

    fn update_from_bind(&mut self, pos: usize, params: &Params) -> Result<usize> {
        if params.is_null(pos)? {
            self.take();
            Ok(pos + 1)
        } else if let Some(val) = self {
            val.update_from_bind(pos, params)
        } else {
            Ok(pos + 1)
        }
    }
}

impl<T> ToSql for &Option<T> where T: OracleDataType {
    fn bind_to(&mut self, pos: usize, params: &mut Params, stmt: &OCIStmt, err: &OCIError) -> Result<usize> {
        if let Some(val) = self {
            // Coerse val into ref mut to satisfy `bind_to`
            let val = val as *const T as *mut T as *const UnsafeCell<T>;
            let val: &UnsafeCell<T> = unsafe { &*val };
            let val = unsafe { &mut *val.get() };
            val.bind_to(pos, params, stmt, err)
        } else {
            Ok(pos + 1)
        }
    }
}

impl<T> ToSql for &mut Option<T> where T: OracleDataType {
    fn bind_to(&mut self, pos: usize, params: &mut Params, stmt: &OCIStmt, err: &OCIError) -> Result<usize> {
        if let Some(val) = self {
            val.bind_to(pos, params, stmt, err)
        } else {
            Err(crate::Error::Interface("OUT (or INOUT) argument cannot be None".into()))
        }
    }

    fn update_from_bind(&mut self, pos: usize, params: &Params) -> Result<usize> {
        if params.is_null(pos)? {
            self.take();
            Ok(pos + 1)
        } else if let Some(val) = self {
            val.update_from_bind(pos, params)
        } else {
            Ok(pos + 1)
        }
    }
}

impl ToSql for Vec<&mut dyn ToSql> {
    fn bind_to(&mut self, mut pos: usize, params: &mut Params, stmt: &OCIStmt, err: &OCIError) -> Result<usize> {
        for item in self.iter_mut() {
            pos = item.bind_to(pos, params, stmt, err)?;
        }
        Ok(pos)
    }

    fn update_from_bind(&mut self, mut pos: usize, params: &Params) -> Result<usize> {
        for item in self.iter_mut() {
            pos = item.update_from_bind(pos, params)?;
        }
        Ok(pos)
    }
}

impl ToSql for &mut Vec<&mut dyn ToSql> {
    fn bind_to(&mut self, mut pos: usize, params: &mut Params, stmt: &OCIStmt, err: &OCIError) -> Result<usize> {
        for item in self.iter_mut() {
            pos = item.bind_to(pos, params, stmt, err)?;
        }
        Ok(pos)
    }

    fn update_from_bind(&mut self, mut pos: usize, params: &Params) -> Result<usize> {
        for item in self.iter_mut() {
            pos = item.update_from_bind(pos, params)?;
        }
        Ok(pos)
    }
}

impl<T: ToSql, const N: usize> ToSql for [T; N] {
    fn bind_to(&mut self, mut pos: usize, params: &mut Params, stmt: &OCIStmt, err: &OCIError) -> Result<usize> {
        for item in self.iter_mut() {
            pos = item.bind_to(pos, params, stmt, err)?;
        }
        Ok(pos)
    }

    fn update_from_bind(&mut self, mut pos: usize, params: &Params) -> Result<usize> {
        for item in self.iter_mut() {
            pos = item.update_from_bind(pos, params)?;
        }
        Ok(pos)
    }
}

impl<T: ToSql, const N: usize> ToSql for &mut [T; N] {
    fn bind_to(&mut self, mut pos: usize, params: &mut Params, stmt: &OCIStmt, err: &OCIError) -> Result<usize> {
        for item in self.iter_mut() {
            pos = item.bind_to(pos, params, stmt, err)?;
        }
        Ok(pos)
    }

    fn update_from_bind(&mut self, mut pos: usize, params: &Params) -> Result<usize> {
        for item in self.iter_mut() {
            pos = item.update_from_bind(pos, params)?;
        }
        Ok(pos)
    }
}

impl<T: ToSql, const N: usize> ToSql for &[T; N] {
    fn bind_to(&mut self, mut pos: usize, params: &mut Params, stmt: &OCIStmt, err: &OCIError) -> Result<usize> {
        for item in self.iter() {
            // Coerse item into ref mut to satisfy `bind_to`
            let val = item as *const T as *mut T as *const UnsafeCell<T>;
            let val: &UnsafeCell<T> = unsafe { &*val };
            let val = unsafe { &mut *val.get() };
            pos = val.bind_to(pos, params, stmt, err)?;
        }
        Ok(pos)
    }
}

impl<T> ToSql for (&str, T) where T: ToSql {
    fn bind_to(&mut self, _pos: usize, params: &mut Params, stmt: &OCIStmt, err: &OCIError) -> Result<usize> {
        let idx = params.index_of(self.0)?;
        self.1.bind_to(idx, params, stmt, err)
    }

    fn update_from_bind(&mut self, _pos: usize, params: &Params) -> Result<usize> {
        let idx = params.index_of(self.0)?;
        self.1.update_from_bind(idx, params)
    }
}

impl<T1,T2> ToSql for ((&str, T1), (&str, T2)) where T1: ToSql, T2: ToSql {
    fn bind_to(&mut self, _pos: usize, params: &mut Params, stmt: &OCIStmt, err: &OCIError) -> Result<usize> {
        let idx = params.index_of(self.0.0)?;
        self.0.1.bind_to(idx, params, stmt, err)?;
        let idx = params.index_of(self.1.0)?;
        self.1.1.bind_to(idx, params, stmt, err)
    }

    fn update_from_bind(&mut self, _pos: usize, params: &Params) -> Result<usize> {
        let idx = params.index_of(self.0.0)?;
        self.0.1.update_from_bind(idx, params)?;
        let idx = params.index_of(self.1.0)?;
        self.1.1.update_from_bind(idx, params)
    }
}

macro_rules! impl_tuple_args {
    ($($item:ident)+) => {
        impl<$($item),+> ToSql for ($($item),+) where $($item: ToSql),+ {
            #[allow(non_snake_case)]
            fn bind_to(&mut self, mut pos: usize, params: &mut Params, stmt: &OCIStmt, err: &OCIError) -> Result<usize> {
                let ($(ref mut $item),+) = *self;
                $(
                    pos = $item.bind_to(pos, params, stmt, err)?;
                )+
                Ok(pos)
            }
            #[allow(non_snake_case)]
            fn update_from_bind(&mut self, mut pos: usize, params: &Params) -> Result<usize> {
                let ($(ref mut $item),+) = *self;
                $(
                    pos = $item.update_from_bind(pos, params)?;
                )+
                Ok(pos)
            }
        }
    };
}

impl_tuple_args! { A B C }
impl_tuple_args! { A B C D }
impl_tuple_args! { A B C D E }
impl_tuple_args! { A B C D E F }
impl_tuple_args! { A B C D E F G }
impl_tuple_args! { A B C D E F G H }
impl_tuple_args! { A B C D E F G H I }
impl_tuple_args! { A B C D E F G H I J }
impl_tuple_args! { A B C D E F G H I J K }
impl_tuple_args! { A B C D E F G H I J K L }
impl_tuple_args! { A B C D E F G H I J K L M }
impl_tuple_args! { A B C D E F G H I J K L M N }
impl_tuple_args! { A B C D E F G H I J K L M N O }
impl_tuple_args! { A B C D E F G H I J K L M N O P }
impl_tuple_args! { A B C D E F G H I J K L M N O P Q }
impl_tuple_args! { A B C D E F G H I J K L M N O P Q R }
impl_tuple_args! { A B C D E F G H I J K L M N O P Q R S }
impl_tuple_args! { A B C D E F G H I J K L M N O P Q R S T }
impl_tuple_args! { A B C D E F G H I J K L M N O P Q R S T U }
impl_tuple_args! { A B C D E F G H I J K L M N O P Q R S T U V }
impl_tuple_args! { A B C D E F G H I J K L M N O P Q R S T U V W }
impl_tuple_args! { A B C D E F G H I J K L M N O P Q R S T U V W X }
impl_tuple_args! { A B C D E F G H I J K L M N O P Q R S T U V W X Y }
impl_tuple_args! { A B C D E F G H I J K L M N O P Q R S T U V W X Y Z }