refactor: SpringRow -> SpringSinkRow

Author: laysakura

springql.h

@@ -52,7 +52,7 @@ typedef void *SpringPipeline;
 /**
  * Row object from an in memory queue.
  */
-typedef void *SpringRow;
+typedef void *SpringSinkRow;
 
 /**
  * Returns default configuration.
@@ -146,7 +146,7 @@ enum SpringErrno spring_command(const SpringPipeline *pipeline, const char *sql)
  *
  * - `Unavailable`: queue named `queue` does not exist.
  */
-SpringRow *spring_pop(const SpringPipeline *pipeline, const char *queue);
+SpringSinkRow *spring_pop(const SpringPipeline *pipeline, const char *queue);
 
 /**
  * Pop a row from an in memory queue. This is a non-blocking function.
@@ -160,9 +160,9 @@ SpringRow *spring_pop(const SpringPipeline *pipeline, const char *queue);
  *
  * - `Unavailable`: queue named `queue` does not exist.
  */
-SpringRow *spring_pop_non_blocking(const SpringPipeline *pipeline,
-                                   const char *queue,
-                                   bool *is_err);
+SpringSinkRow *spring_pop_non_blocking(const SpringPipeline *pipeline,
+                                       const char *queue,
+                                       bool *is_err);
 
 /**
  * Frees heap occupied by a `SpringRow`.
@@ -172,7 +172,7 @@ SpringRow *spring_pop_non_blocking(const SpringPipeline *pipeline,
  * - `Ok`: on success.
  * - `CNull`: `pipeline` is a NULL pointer.
  */
-enum SpringErrno spring_row_close(SpringRow *row);
+enum SpringErrno spring_row_close(SpringSinkRow *row);
 
 /**
  * Get a 2-byte integer column.
@@ -191,7 +191,7 @@ enum SpringErrno spring_row_close(SpringRow *row);
  *   - `i_col` is out of range.
  * - `CNull`: Column value is NULL.
  */
-enum SpringErrno spring_column_short(const SpringRow *row, uint16_t i_col, short *out);
+enum SpringErrno spring_column_short(const SpringSinkRow *row, uint16_t i_col, short *out);
 
 /**
  * Get a 4-byte integer column.
@@ -210,7 +210,7 @@ enum SpringErrno spring_column_short(const SpringRow *row, uint16_t i_col, short
  *   - `i_col` is out of range.
  * - `CNull`: Column value is NULL.
  */
-enum SpringErrno spring_column_int(const SpringRow *row, uint16_t i_col, int *out);
+enum SpringErrno spring_column_int(const SpringSinkRow *row, uint16_t i_col, int *out);
 
 /**
  * Get an 8-byte integer column.
@@ -229,7 +229,7 @@ enum SpringErrno spring_column_int(const SpringRow *row, uint16_t i_col, int *ou
  *   - `i_col` is out of range.
  * - `CNull`: Column value is NULL.
  */
-enum SpringErrno spring_column_long(const SpringRow *row, uint16_t i_col, long *out);
+enum SpringErrno spring_column_long(const SpringSinkRow *row, uint16_t i_col, long *out);
 
 /**
  * Get a 4-byte unsigned integer column.
@@ -248,7 +248,7 @@ enum SpringErrno spring_column_long(const SpringRow *row, uint16_t i_col, long *
  *   - `i_col` is out of range.
  * - `CNull`: Column value is NULL.
  */
-enum SpringErrno spring_column_unsigned_int(const SpringRow *row,
+enum SpringErrno spring_column_unsigned_int(const SpringSinkRow *row,
                                             uint16_t i_col,
                                             unsigned int *out);
 
@@ -270,7 +270,7 @@ enum SpringErrno spring_column_unsigned_int(const SpringRow *row,
  *   - `i_col` is out of range.
  * - `CNull`: Column value is NULL.
  */
-int spring_column_text(const SpringRow *row, uint16_t i_col, char *out, int out_len);
+int spring_column_text(const SpringSinkRow *row, uint16_t i_col, char *out, int out_len);
 
 /**
  * Get a BLOB column.
@@ -290,7 +290,7 @@ int spring_column_text(const SpringRow *row, uint16_t i_col, char *out, int out_
  *   - `i_col` is out of range.
  * - `CNull`: Column value is NULL.
  */
-int spring_column_blob(const SpringRow *row, uint16_t i_col, void *out, int out_len);
+int spring_column_blob(const SpringSinkRow *row, uint16_t i_col, void *out, int out_len);
 
 /**
  * Get a bool column.
@@ -309,7 +309,7 @@ int spring_column_blob(const SpringRow *row, uint16_t i_col, void *out, int out_
  *   - `i_col` is out of range.
  * - `CNull`: Column value is NULL.
  */
-enum SpringErrno spring_column_bool(const SpringRow *row, uint16_t i_col, bool *out);
+enum SpringErrno spring_column_bool(const SpringSinkRow *row, uint16_t i_col, bool *out);
 
 /**
  * Get a 4-byte floating point column.
@@ -328,7 +328,7 @@ enum SpringErrno spring_column_bool(const SpringRow *row, uint16_t i_col, bool *
  *   - `i_col` is out of range.
  * - `CNull`: Column value is NULL.
  */
-enum SpringErrno spring_column_float(const SpringRow *row, uint16_t i_col, float *out);
+enum SpringErrno spring_column_float(const SpringSinkRow *row, uint16_t i_col, float *out);
 
 /**
  * Write the most recent error number into `errno` and message into a caller-provided buffer as a UTF-8

src/lib.rs

@@ -9,7 +9,7 @@ mod spring_config;
 pub mod spring_errno;
 pub mod spring_last_err;
 mod spring_pipeline;
-mod spring_row;
+mod spring_sink_row;
 
 use std::{
     ffi::{c_void, CStr},
@@ -24,7 +24,7 @@ use crate::{
     spring_errno::SpringErrno,
     spring_last_err::{update_last_error, LastError},
     spring_pipeline::SpringPipeline,
-    spring_row::SpringRow,
+    spring_sink_row::SpringSinkRow,
 };
 use ::springql::{error::SpringError, SpringPipeline as Pipeline};
 
@@ -163,13 +163,13 @@ pub unsafe extern "C" fn spring_command(
 pub unsafe extern "C" fn spring_pop(
     pipeline: *const SpringPipeline,
     queue: *const c_char,
-) -> *mut SpringRow {
+) -> *mut SpringSinkRow {
     let pipeline = (*pipeline).as_pipeline();
     let queue = CStr::from_ptr(queue).to_string_lossy().into_owned();
     let result = with_catch(|| pipeline.pop(&queue));
     match result {
         Ok(row) => {
-            let row = SpringRow::new(row);
+            let row = SpringSinkRow::new(row);
             row.into_ptr()
         }
         Err(_) => ptr::null_mut(),
@@ -191,13 +191,13 @@ pub unsafe extern "C" fn spring_pop_non_blocking(
     pipeline: *const SpringPipeline,
     queue: *const c_char,
     is_err: *mut bool,
-) -> *mut SpringRow {
+) -> *mut SpringSinkRow {
     let pipeline = (*pipeline).as_pipeline();
     let queue = CStr::from_ptr(queue).to_string_lossy().into_owned();
     let result = with_catch(|| pipeline.pop_non_blocking(&queue));
     match result {
         Ok(Some(row)) => {
-            let ptr = SpringRow::new(row);
+            let ptr = SpringSinkRow::new(row);
             *is_err = false;
             ptr.into_ptr()
         }
@@ -219,11 +219,11 @@ pub unsafe extern "C" fn spring_pop_non_blocking(
 /// - `Ok`: on success.
 /// - `CNull`: `pipeline` is a NULL pointer.
 #[no_mangle]
-pub extern "C" fn spring_row_close(row: *mut SpringRow) -> SpringErrno {
+pub extern "C" fn spring_row_close(row: *mut SpringSinkRow) -> SpringErrno {
     if row.is_null() {
         SpringErrno::CNull
     } else {
-        SpringRow::drop(row);
+        SpringSinkRow::drop(row);
         SpringErrno::Ok
     }
 }
@@ -245,7 +245,7 @@ pub extern "C" fn spring_row_close(row: *mut SpringRow) -> SpringErrno {
 /// - `CNull`: Column value is NULL.
 #[no_mangle]
 pub unsafe extern "C" fn spring_column_short(
-    row: *const SpringRow,
+    row: *const SpringSinkRow,
     i_col: u16,
     out: *mut c_short,
 ) -> SpringErrno {
@@ -278,7 +278,7 @@ pub unsafe extern "C" fn spring_column_short(
 /// - `CNull`: Column value is NULL.
 #[no_mangle]
 pub unsafe extern "C" fn spring_column_int(
-    row: *const SpringRow,
+    row: *const SpringSinkRow,
     i_col: u16,
     out: *mut c_int,
 ) -> SpringErrno {
@@ -311,7 +311,7 @@ pub unsafe extern "C" fn spring_column_int(
 /// - `CNull`: Column value is NULL.
 #[no_mangle]
 pub unsafe extern "C" fn spring_column_long(
-    row: *const SpringRow,
+    row: *const SpringSinkRow,
     i_col: u16,
     out: *mut c_long,
 ) -> SpringErrno {
@@ -344,7 +344,7 @@ pub unsafe extern "C" fn spring_column_long(
 /// - `CNull`: Column value is NULL.
 #[no_mangle]
 pub unsafe extern "C" fn spring_column_unsigned_int(
-    row: *const SpringRow,
+    row: *const SpringSinkRow,
     i_col: u16,
     out: *mut c_uint,
 ) -> SpringErrno {
@@ -378,7 +378,7 @@ pub unsafe extern "C" fn spring_column_unsigned_int(
 /// - `CNull`: Column value is NULL.
 #[no_mangle]
 pub unsafe extern "C" fn spring_column_text(
-    row: *const SpringRow,
+    row: *const SpringSinkRow,
     i_col: u16,
     out: *mut c_char,
     out_len: c_int,
@@ -414,7 +414,7 @@ pub unsafe extern "C" fn spring_column_text(
 /// - `CNull`: Column value is NULL.
 #[no_mangle]
 pub unsafe extern "C" fn spring_column_blob(
-    row: *const SpringRow,
+    row: *const SpringSinkRow,
     i_col: u16,
     out: *mut c_void,
     out_len: c_int,
@@ -449,7 +449,7 @@ pub unsafe extern "C" fn spring_column_blob(
 /// - `CNull`: Column value is NULL.
 #[no_mangle]
 pub unsafe extern "C" fn spring_column_bool(
-    row: *const SpringRow,
+    row: *const SpringSinkRow,
     i_col: u16,
     out: *mut bool,
 ) -> SpringErrno {
@@ -482,7 +482,7 @@ pub unsafe extern "C" fn spring_column_bool(
 /// - `CNull`: Column value is NULL.
 #[no_mangle]
 pub unsafe extern "C" fn spring_column_float(
-    row: *const SpringRow,
+    row: *const SpringSinkRow,
     i_col: u16,
     out: *mut c_float,
 ) -> SpringErrno {

src/spring_row.rs src/spring_sink_row.rssrc/spring_row.rs renamed to src/spring_sink_row.rs

@@ -6,25 +6,25 @@ use std::{ffi::c_void, mem};
 /// Row object from an in memory queue.
 #[non_exhaustive]
 #[repr(transparent)]
-pub struct SpringRow(*mut c_void);
+pub struct SpringSinkRow(*mut c_void);
 
-impl SpringRow {
+impl SpringSinkRow {
     pub fn new(sink_row: SinkRow) -> Self {
-        SpringRow(unsafe { mem::transmute(Box::new(sink_row)) })
+        SpringSinkRow(unsafe { mem::transmute(Box::new(sink_row)) })
     }
 
     pub fn as_row(&self) -> &SinkRow {
         unsafe { &*(self.0 as *const SinkRow) }
     }
 
-    pub fn drop(ptr: *mut SpringRow) {
+    pub fn drop(ptr: *mut SpringSinkRow) {
         let outer = unsafe { Box::from_raw(ptr) };
         let inner = unsafe { Box::from_raw(outer.0) };
         drop(inner);
         drop(outer);
     }
 
-    pub fn into_ptr(self) -> *mut SpringRow {
+    pub fn into_ptr(self) -> *mut SpringSinkRow {
         Box::into_raw(Box::new(self))
     }
 }