SQLiteBlobStream Class Reference

Public Member Functions
	SQLiteBlobStream (sqlite3_blob *blob, bool readOnly) noexcept
	SQLiteBlobStream (SQLiteBlobStream &&rhs) noexcept
SQLiteBlobStream &	operator= (SQLiteBlobStream &&rhs) noexcept
	~SQLiteBlobStream () noexcept
bool	IsOpen () const noexcept
int	Close () noexcept
int	Write (const void *ptr, int size) noexcept
int	Read (void *ptr, int &size) noexcept
bool	IsEof () const noexcept

Static Public Member Functions
static std::optional< SQLiteBlobStream >	Open (sqlite3 *db, const char *schema, const char *table, const char *column, int64_t rowID, bool readOnly) noexcept

Private Attributes
sqlite3_blob *	mBlob { nullptr }
size_t	mBlobSize { 0 }
int	mOffset { 0 }
bool	mIsReadOnly { false }

Detailed Description

Definition at line 216 of file ProjectFileIO.cpp.

Constructor & Destructor Documentation

SQLiteBlobStream() [1/2]

SQLiteBlobStream::SQLiteBlobStream ( sqlite3_blob *  blob, bool  readOnly  )

inlinenoexcept

Definition at line 237 of file ProjectFileIO.cpp.

       : mBlob(blob)
       , mIsReadOnly(readOnly)
   {
      mBlobSize = sqlite3_blob_bytes(blob);
   }

References mBlobSize.

SQLiteBlobStream() [2/2]

SQLiteBlobStream::SQLiteBlobStream ( SQLiteBlobStream &&  rhs )

inlinenoexcept

Definition at line 244 of file ProjectFileIO.cpp.

   {
      *this = std::move(rhs);
   }

~SQLiteBlobStream()

SQLiteBlobStream::~SQLiteBlobStream ( )

inlinenoexcept

Definition at line 259 of file ProjectFileIO.cpp.

   {
      // Destructor should not throw and there is no
      // way to handle the error otherwise
      (void) Close();
   }

References Close().

Here is the call graph for this function:

Member Function Documentation

Close()

int SQLiteBlobStream::Close ( )

inlinenoexcept

Definition at line 271 of file ProjectFileIO.cpp.

   {
      if (mBlob == nullptr)
         return SQLITE_OK;
 
      const int rc = sqlite3_blob_close(mBlob);
 
      mBlob = nullptr;
 
      return rc;
   }

References mBlob.

Referenced by ~SQLiteBlobStream().

Here is the caller graph for this function:

IsEof()

bool SQLiteBlobStream::IsEof ( ) const

inlinenoexcept

Definition at line 324 of file ProjectFileIO.cpp.

   {
      return mOffset == mBlobSize;
   }

References mBlobSize, and mOffset.

IsOpen()

bool SQLiteBlobStream::IsOpen ( ) const

inlinenoexcept

Definition at line 266 of file ProjectFileIO.cpp.

   {
      return mBlob != nullptr;
   }

References mBlob.

Referenced by Read(), and Write().

Here is the caller graph for this function:

Open()

static std::optional< SQLiteBlobStream > SQLiteBlobStream::Open ( sqlite3 *  db, const char *  schema, const char *  table, const char *  column, int64_t  rowID, bool  readOnly  )

inlinestaticnoexcept

Definition at line 219 of file ProjectFileIO.cpp.

   {
      if (db == nullptr)
         return {};
 
      sqlite3_blob* blob = nullptr;
 
      const int rc = sqlite3_blob_open(
         db, schema, table, column, rowID, readOnly ? 0 : 1, &blob);
 
      if (rc != SQLITE_OK)
         return {};
 
      return std::make_optional<SQLiteBlobStream>(blob, readOnly);
   }

Referenced by BufferedProjectBlobStream::OpenBlob(), and ProjectFileIO::WriteDoc().

Here is the caller graph for this function:

operator=()

SQLiteBlobStream & SQLiteBlobStream::operator= ( SQLiteBlobStream &&  rhs )

inlinenoexcept

Definition at line 249 of file ProjectFileIO.cpp.

   {
      std::swap(mBlob, rhs.mBlob);
      std::swap(mBlobSize, rhs.mBlobSize);
      std::swap(mOffset, rhs.mOffset);
      std::swap(mIsReadOnly, rhs.mIsReadOnly);
 
      return *this;
   }

References mBlob, mBlobSize, mIsReadOnly, mOffset, and anonymous_namespace{NoteTrack.cpp}::swap().

Here is the call graph for this function:

Read()

int SQLiteBlobStream::Read ( void *  ptr, int &  size  )

inlinenoexcept

Definition at line 299 of file ProjectFileIO.cpp.

   {
      if (!IsOpen() || ptr == nullptr)
         return SQLITE_MISUSE;
 
      const int availableBytes = mBlobSize - mOffset;
 
      if (availableBytes == 0)
      {
         size = 0;
         return SQLITE_OK;
      }
      else if (availableBytes < size)
      {
         size = availableBytes;
      }
 
      const int rc = sqlite3_blob_read(mBlob, ptr, size, mOffset);
 
      if (rc == SQLITE_OK)
         mOffset += size;
 
      return rc;
   }

References IsOpen(), mBlob, mBlobSize, mOffset, and size.

Here is the call graph for this function:

Write()

int SQLiteBlobStream::Write ( const void *  ptr, int  size  )

inlinenoexcept

Definition at line 283 of file ProjectFileIO.cpp.

   {
      // Stream APIs usually return the number of bytes written.
      // sqlite3_blob_write is all-or-nothing function,
      // so Write will return the result of the call
      if (!IsOpen() || mIsReadOnly || ptr == nullptr)
         return SQLITE_MISUSE;
 
      const int rc = sqlite3_blob_write(mBlob, ptr, size, mOffset);
 
      if (rc == SQLITE_OK)
         mOffset += size;
 
      return rc;
   }

References IsOpen(), mBlob, mIsReadOnly, mOffset, and size.

Here is the call graph for this function:

Member Data Documentation

mBlob

sqlite3_blob* SQLiteBlobStream::mBlob { nullptr }

private

Definition at line 330 of file ProjectFileIO.cpp.

Referenced by Close(), IsOpen(), operator=(), Read(), and Write().

mBlobSize

size_t SQLiteBlobStream::mBlobSize { 0 }

private

Definition at line 331 of file ProjectFileIO.cpp.

Referenced by IsEof(), operator=(), Read(), and SQLiteBlobStream().

mIsReadOnly

bool SQLiteBlobStream::mIsReadOnly { false }

private

Definition at line 335 of file ProjectFileIO.cpp.

Referenced by operator=(), and Write().

mOffset

int SQLiteBlobStream::mOffset { 0 }

private

Definition at line 333 of file ProjectFileIO.cpp.

Referenced by IsEof(), operator=(), Read(), and Write().

---

The documentation for this class was generated from the following file:

• ProjectFileIO.cpp