Add TpToken newtype

Author: Joshua Nelson

src/context_api/mod.rs

@@ -24,7 +24,7 @@
 //! ```
 //! # #[macro_use] extern crate yottadb;
 //! use yottadb::context_api::Context;
-//! use yottadb::{YDB_NOTTP, DeleteType, YDBResult};
+//! use yottadb::{DeleteType, YDBResult};
 //!
 //! fn main() -> YDBResult<()> {
 //!     let ctx = Context::new();
@@ -49,9 +49,9 @@ use std::ops::{Deref, DerefMut};
 use std::time::Duration;
 use std::fmt;
 
-use crate::craw::{YDB_NOTTP, YDB_ERR_NODEEND};
+use crate::craw::YDB_ERR_NODEEND;
 use crate::simple_api::{
-    self, tp_st, Key, YDBResult, YDBError, DataReturn, DeleteType, TransactionStatus,
+    self, tp_st, Key, YDBResult, YDBError, DataReturn, DeleteType, TransactionStatus, TpToken,
 };
 
 // Private macro to help make iterators
@@ -119,7 +119,7 @@ macro_rules! make_ckey {
 #[derive(Debug, Clone, Eq, PartialEq, Hash)]
 struct ContextInternal {
     buffer: Option<Vec<u8>>,
-    tptoken: u64,
+    tptoken: TpToken,
 }
 
 /// A struct that keeps track of the current transaction and error buffer.
@@ -192,7 +192,7 @@ impl Context {
         Context {
             context: Rc::new(RefCell::new(ContextInternal {
                 buffer: Some(Vec::with_capacity(1024)),
-                tptoken: YDB_NOTTP,
+                tptoken: TpToken::default(),
             })),
         }
     }
@@ -234,7 +234,7 @@ impl Context {
     ///
     /// # See also
     /// - [`Context::tp`](struct.Context.html#method.tp)
-    pub fn tptoken(&self) -> u64 {
+    pub fn tptoken(&self) -> TpToken {
         self.borrow().tptoken
     }
 
@@ -348,7 +348,7 @@ impl Context {
         let result = tp_st(
             tptoken,
             Vec::with_capacity(50),
-            |tptoken: u64| {
+            |tptoken: TpToken| {
                 self.context.borrow_mut().tptoken = tptoken;
                 f(self)
             },

src/lib.rs

@@ -46,11 +46,14 @@ pub mod context_api;
 pub mod craw;
 pub mod simple_api;
 
-pub use craw::{YDB_NOTTP, YDB_ERR_GVUNDEF, YDB_ERR_LVUNDEF};
+pub use craw::{YDB_ERR_GVUNDEF, YDB_ERR_LVUNDEF};
 pub use simple_api::{
     call_in::{CallInDescriptor, CallInTableDescriptor},
-    DataReturn, DeleteType, TransactionStatus, YDBError, YDBResult,
+    DataReturn, DeleteType, TransactionStatus, TpToken, YDBError, YDBResult,
 };
+// This can't use `TpToken::default` because traits cannot have `const fn`
+/// The default transaction processing token if no transaction is in progress.
+pub const YDB_NOTTP: TpToken = TpToken(craw::YDB_NOTTP);
 
 use std::os::raw::c_int;
 /// Cleans up the process connection/access to all databases and all yottadb data structures.

src/simple_api/call_in.rs

@@ -19,7 +19,7 @@
 
 use std::ffi::{CString, CStr};
 use crate::craw::ci_name_descriptor;
-use super::{resize_call, YDBResult};
+use super::{resize_call, YDBResult, TpToken};
 
 /// The descriptor for a call-in table opened with [`ci_tab_open_t`].
 ///
@@ -66,7 +66,7 @@ pub struct CallInTableDescriptor(usize);
 /// # Ok(())
 /// # }
 pub fn ci_tab_open_t(
-    tptoken: u64, err_buffer: Vec<u8>, file: &CStr,
+    tptoken: TpToken, err_buffer: Vec<u8>, file: &CStr,
 ) -> YDBResult<(CallInTableDescriptor, Vec<u8>)> {
     use crate::craw::ydb_ci_tab_open_t;
 
@@ -107,7 +107,7 @@ pub fn ci_tab_open_t(
 /// # }
 /// ```
 pub fn ci_tab_switch_t(
-    tptoken: u64, err_buffer: Vec<u8>, new_handle: CallInTableDescriptor,
+    tptoken: TpToken, err_buffer: Vec<u8>, new_handle: CallInTableDescriptor,
 ) -> YDBResult<(CallInTableDescriptor, Vec<u8>)> {
     use crate::craw::ydb_ci_tab_switch_t;
 
@@ -160,7 +160,7 @@ pub fn ci_tab_switch_t(
 #[macro_export]
 macro_rules! ci_t {
     ($tptoken: expr, $err_buffer: expr, $routine: expr $(, $args: expr)* $(,)?) => {{
-        let tptoken: u64 = $tptoken;
+        let tptoken: $crate::TpToken = $tptoken;
         let err_buffer: ::std::vec::Vec<u8> = $err_buffer;
         let routine: &::std::ffi::CStr = $routine;
 
@@ -250,7 +250,7 @@ impl Drop for CallInDescriptor {
 #[macro_export]
 macro_rules! cip_t {
     ($tptoken: expr, $err_buffer: expr, $routine: expr, $($args: expr),* $(,)?) => {{
-        let tptoken: u64 = $tptoken;
+        let tptoken: $crate::TpToken = $tptoken;
         let err_buffer: ::std::vec::Vec<u8> = $err_buffer;
         let routine: &mut $crate::simple_api::call_in::CallInDescriptor = $routine;