sibyl 0.7.0

An OCI-based (synchronous or asynchronous) interface between Rust applications and Oracle databases
Documentation
//! Fixed or variable-length string

mod tosql;

use crate::{Result, oci::{self, *}};

use super::Ctx;

pub(crate) fn new(size: u32, env: &OCIEnv, err: &OCIError) -> Result<Ptr<OCIString>> {
    let mut txt = Ptr::<OCIString>::null();
    oci::string_resize(env, err, size, txt.as_mut_ptr())?;
    Ok( txt )
}

pub(crate) fn free(txt: &mut Ptr<OCIString>, env: &OCIEnv, err: &OCIError) {
    unsafe {
        OCIStringResize(env, err, 0, txt.as_mut_ptr());
    }
}

pub(crate) fn capacity(txt: *const OCIString, env: &OCIEnv, err: &OCIError) -> Result<usize> {
    let mut size = 0u32;
    oci::string_alloc_size(env, err, txt, &mut size)?;
    Ok( size as usize )
}

pub(crate) fn to_string(txt: &OCIString, env: &OCIEnv) -> String {
    let ptr = raw_ptr(txt, env);
    let len = len(txt, env);
    let txt = unsafe {
        std::slice::from_raw_parts(ptr, len)
    };
    String::from_utf8_lossy(txt).to_string()
}

pub(crate) fn raw_ptr(txt: &OCIString, env: &OCIEnv) -> *const u8 {
    unsafe {
        OCIStringPtr(env, txt)
    }
}

pub(crate) fn len(txt: &OCIString, env: &OCIEnv) -> usize {
    unsafe {
        OCIStringSize(env, txt) as usize
    }
}

pub(crate) fn as_str<'a>(txt: &OCIString, env: &OCIEnv) -> &'a str {
    unsafe {
        std::str::from_utf8_unchecked(
            std::slice::from_raw_parts(
                raw_ptr(txt, env),
                len(txt, env)
            )
        )
    }
}

/// Represents Oracle character types - VARCHAR, LONG, etc.
pub struct Varchar<'a> {
    txt: Ptr<OCIString>,
    ctx: &'a dyn Ctx,
}

impl Drop for Varchar<'_> {
    fn drop(&mut self) {
        free(&mut self.txt, self.ctx.as_ref(), self.ctx.as_ref());
    }
}

impl<'a> Varchar<'a> {
    /**
        Returns a new Varchar constructed from the specified string

        # Example
        ```
        use sibyl::{ self as oracle, Varchar };
        let env = oracle::env()?;

        let txt = Varchar::from("Hello, World!", &env)?;

        assert!(txt.capacity()? >= 13);
        assert_eq!(txt.len(), 13);
        assert_eq!(txt.as_str(), "Hello, World!");
        # Ok::<(),oracle::Error>(())
        ```
    */
    pub fn from(text: &str, ctx: &'a dyn Ctx) -> Result<Self> {
        let mut txt = Ptr::<OCIString>::null();
        oci::string_assign_text(ctx.as_ref(), ctx.as_ref(), text.as_ptr(), text.len() as u32, txt.as_mut_ptr())?;
        Ok( Self { ctx, txt } )
    }

    /**
        Returns a new Varchar constructed with the copy of the date from the `other` Varchar.

        # Example
        ```
        use sibyl::{ self as oracle, Varchar };
        let env = oracle::env()?;

        let src = Varchar::from("Hello, World!", &env)?;
        let txt = Varchar::from_varchar(&src)?;

        assert_eq!(txt.len(), 13);
        assert_eq!(txt.as_str(), "Hello, World!");
        # Ok::<(),oracle::Error>(())
        ```
    */
    pub fn from_varchar(other: &'a Varchar) -> Result<Self> {
        let ctx = other.ctx;
        let mut txt = Ptr::<OCIString>::null();
        oci::string_assign(ctx.as_ref(), ctx.as_ref(), &other.txt, txt.as_mut_ptr())?;
        Ok( Self { ctx, txt } )
    }

    pub(crate) fn from_ocistring(oci_str: &OCIString, ctx: &'a dyn Ctx) -> Result<Self> {
        let mut txt = Ptr::<OCIString>::null();
        oci::string_assign(ctx.as_ref(), ctx.as_ref(), oci_str, txt.as_mut_ptr())?;
        Ok( Self { ctx, txt } )
    }

    /**
        Returns a new Varchar with the memory allocated for the txt data.

        # Example
        ```
        use sibyl::{ self as oracle, Varchar };
        let env = oracle::env()?;

        let txt = Varchar::with_capacity(19, &env)?;

        assert!(txt.capacity()? >= 19);
        assert_eq!(txt.len(), 0);
        # Ok::<(),oracle::Error>(())
        ```
    */
    pub fn with_capacity(size: usize, ctx: &'a dyn Ctx) -> Result<Self> {
        let txt = new(size as u32, ctx.as_ref(), ctx.as_ref())?;
        Ok( Self { ctx, txt } )
    }

    /**
        Sets the content of self to `text`

        # Example
        ```
        use sibyl::{ self as oracle, Varchar };
        let env = oracle::env()?;

        let mut txt = Varchar::with_capacity(0, &env)?;
        txt.set("Hello, World!")?;

        assert_eq!(txt.len(), 13);
        assert_eq!(txt.as_str(), "Hello, World!");
        # Ok::<(),oracle::Error>(())
        ```
    */
    pub fn set(&mut self, text: &str) -> Result<()> {
        oci::string_assign_text(self.ctx.as_ref(), self.ctx.as_ref(), text.as_ptr(), text.len() as u32, self.txt.as_mut_ptr())
    }

    /**
        Returns the size of the string in bytes.

        # Example
        ```
        use sibyl::{ self as oracle, Varchar };
        let env = oracle::env()?;

        let mut txt = Varchar::from("🚲🛠📬🎓", &env)?;

        assert_eq!(txt.len(), 16);
        # Ok::<(),oracle::Error>(())
        ```
    */
    pub fn len(&self) -> usize {
        len(&self.txt, self.ctx.as_ref())
    }

    /**
        Returns the allocated size of string memory in bytes

        # Example
        ```
        use sibyl::{ self as oracle, Varchar };
        let env = oracle::env()?;

        let mut txt = Varchar::from("🚲🛠📬🎓", &env)?;

        assert!(txt.capacity()? >= 16);
        # Ok::<(),oracle::Error>(())
        ```
    */
    pub fn capacity(&self) -> Result<usize> {
        capacity(self.txt.get(), self.ctx.as_ref(), self.ctx.as_ref())
    }

    /**
        Changes the size of the memory of a string in the object cache.
        Content of the string is not preserved.

        # Example
        ```
        use sibyl::{ self as oracle, Varchar };
        let env = oracle::env()?;

        let mut txt = Varchar::with_capacity(10, &env)?;
        assert!(txt.capacity()? >= 10);

        txt.resize(20)?;
        assert!(txt.capacity()? >= 20);

        txt.resize(0)?;
        // Cannot not ask for capacity after resize to 0.
        // Yes, it works for Raw, but not for Varchars
        let res = txt.capacity();
        assert!(res.is_err());
        if let Err( sibyl::Error::Oracle(code, _message) ) = res {
            assert_eq!(code, 21500);
        } else {
            panic!("cannot match the error");
        }

        txt.resize(16)?;
        assert!(txt.capacity()? >= 16);
        # Ok::<(),oracle::Error>(())
        ```
    */
    pub fn resize(&mut self, new_size: usize) -> Result<()> {
        oci::string_resize(self.ctx.as_ref(), self.ctx.as_ref(), new_size as u32, self.txt.as_mut_ptr())
    }

    /**
        Extracts a string slice containing the entire content of the VARCHAR.

        # Example
        ```
        use sibyl::{ self as oracle, Varchar };
        let env = oracle::env()?;

        let txt = Varchar::from("Hello, World!", &env)?;

        assert_eq!(txt.as_str(), "Hello, World!");
        # Ok::<(),oracle::Error>(())
        ```
    */
    pub fn as_str(&self) -> &str {
        as_str(&self.txt, self.ctx.as_ref())
    }
}

impl std::fmt::Debug for Varchar<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        const MAX_LEN : usize = 50;
        let len = self.len();
        if len == 0 {
            f.write_str("VARCHAR ''")
        } else if len <= MAX_LEN {
            f.write_fmt(format_args!("VARCHAR '{}'", self.as_str()))
        } else {
            f.write_fmt(format_args!("VARCHAR '{}...'", &self.as_str()[..MAX_LEN]))
        }
    }
}

impl std::string::ToString for Varchar<'_> {
    fn to_string(&self) -> String {
        to_string(&self.txt, self.ctx.as_ref())
    }
}