mimir 0.3.5

Rust bindings over the Oracle Database Programming Interface for Drivers and Applications
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

// Copyright (c) 2017 mimir developers
//
// Licensed under the Apache License, Version 2.0
// <LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0> or the MIT
// license <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. All files in the project carrying such notice may not be copied,
// modified, or distributed except according to those terms.

//! Object type handles are used to represent types such as those created by the SQL command CREATE
//! OR REPLACE TYPE. They are created using the function `Connection::get_object_type()` or
//! implicitly when fetching from a column containing objects by calling the function
//! `Statement::get_query_info()`. Object types are also retrieved when used as attributes in
//! another object by calling the function `ObjectAttribute::get_info()` or as the element type of a
//! collection by calling the function `ObjectType::get_info()`. They are destroyed when the last
//! reference is released by calling the function `ObjectType::release()`.
use error::{ErrorKind, Result};
use object::Object;
use odpi::externs;
use odpi::opaque::{ODPIObject, ODPIObjectAttr, ODPIObjectType};
use odpi::structs::ODPIObjectTypeInfo;
use std::ptr;

/// Object type handles are used to represent types such as those created by the SQL command CREATE
/// OR REPLACE TYPE.
#[derive(Debug)]
pub struct ObjectType {
    /// A pointer to the opaque `ODPIObjectType`.
    inner: *mut ODPIObjectType,
}

impl ObjectType {
    /// Get the pointer to the inner ODPI struct.
    #[doc(hidden)]
    pub fn inner(&self) -> *mut ODPIObjectType {
        self.inner
    }

    /// Creates an object of the specified type and returns a reference to it. This reference should
    ///  be released as soon as it is no longer needed.
    pub fn create(&self) -> Result<Object> {
        let mut object: *mut ODPIObject = ptr::null_mut();

        try_dpi!(
            externs::dpiObjectType_createObject(self.inner, &mut object),
            Ok(object.into()),
            ErrorKind::ObjectType("dpiObjectType_createObject".to_string())
        )
    }

    /// Returns the list of attributes that belong to the object type.
    pub fn get_attributes(&self, length: u16) -> Result<Vec<*mut ODPIObjectAttr>> {
        let mut buffer: Vec<*mut ODPIObjectAttr> = Vec::with_capacity(length as usize);
        let buf_ptr = buffer.as_mut_ptr();

        try_dpi!(
            externs::dpiObjectType_getAttributes(self.inner, length, buf_ptr),
            {
                unsafe { buffer.set_len(length as usize) };
                Ok(buffer)
            },
            ErrorKind::ObjectType("dpiObjectType_getAttributes".to_string())
        )
    }

    /// Returns information about the object type.
    pub fn get_info(&self) -> Result<ODPIObjectTypeInfo> {
        let mut object_type_info: ODPIObjectTypeInfo = Default::default();

        try_dpi!(
            externs::dpiObjectType_getInfo(self.inner, &mut object_type_info),
            Ok(object_type_info),
            ErrorKind::ObjectType("dpiObjectType_getInfo".to_string())
        )
    }

    /// Releases a reference to the object type. A count of the references to the object type is
    /// maintained and when this count reaches zero, the memory associated with the object type is
    /// freed.
    pub fn release(&self) -> Result<()> {
        try_dpi!(
            externs::dpiObjectType_release(self.inner),
            Ok(()),
            ErrorKind::ObjectType("dpiObjectType_release".to_string())
        )
    }
}

impl From<*mut ODPIObjectType> for ObjectType {
    fn from(oot: *mut ODPIObjectType) -> Self {
        Self { inner: oot }
    }
}