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

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

//! This structure is used to represent the unique identifier of a row in the database and is
//! available by handle to a calling application or driver. Rowids cannot be created or set directly
//! but are created implicitly when a variable of type `DPI_ORACLE_TYPE_ROWID` is created. They are
//! destroyed when the last reference is released by a call to the function `Rowid::release()`. All
//! of the attributes of the structure `ODPIBaseType` are included in this structure in addition to
//! the ones specific to this structure described below.
use error::{ErrorKind, Result};
use odpi::externs;
use odpi::opaque::ODPIRowid;
use std::ptr;
use util::ODPIStr;

/// This structure is used to represent the unique identifier of a row in the database and is
/// available by handle to a calling application or driver.
pub struct Rowid {
    /// The ODPI-C rowid
    inner: *mut ODPIRowid,
}

impl Rowid {
    /// Get the `inner` value.
    #[doc(hidden)]
    pub fn inner(&self) -> *mut ODPIRowid {
        self.inner
    }

    /// Adds a reference to the rowid. This is intended for situations where a reference to the
    /// rowid needs to be maintained independently of the reference returned when the rowid was
    /// created.
    pub fn add_ref(&self) -> Result<()> {
        try_dpi!(
            externs::dpiRowid_addRef(self.inner),
            Ok(()),
            ErrorKind::Rowid("dpiRowid_addRef".to_string())
        )
    }

    /// Returns the string (base64) representation of the rowid.
    pub fn get_string_value(&self) -> Result<String> {
        let mut value = ptr::null();
        let mut value_length = 0;

        try_dpi!(
            externs::dpiRowid_getStringValue(self.inner, &mut value, &mut value_length),
            {
                if value.is_null() {
                    Ok("".to_string())
                } else {
                    let res = ODPIStr::new(value, value_length);
                    Ok(res.into())
                }
            },
            ErrorKind::Rowid("dpiRowid_getStringValue".to_string())
        )
    }

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

impl From<*mut ODPIRowid> for Rowid {
    fn from(inner: *mut ODPIRowid) -> Rowid {
        Rowid { inner: inner }
    }
}