fbcpp::BlobOptions Class Reference

Additional options used when creating or opening blobs. More...

#include <Blob.h>

Public Member Functions
const std::vector< std::uint8_t > &	getBpb () const noexcept
	Retrieves the blob parameter block (BPB) used during blob operations.
BlobOptions &	setBpb (const std::vector< std::uint8_t > &value)
	Sets the blob parameter block (BPB) using a copy of the provided value.
BlobOptions &	setBpb (std::vector< std::uint8_t > &&value)
	Sets the blob parameter block (BPB) by moving the provided value.
const std::optional< BlobType >	getType () const
	Retrieves the blob type to be used for blob operations.
BlobOptions &	setType (BlobType value)
	Sets the blob type to be used for blob operations.
const std::optional< BlobType >	getSourceType () const
	Retrieves the source blob subtype.
BlobOptions &	setSourceType (BlobType value)
	Sets the source blob subtype.
const std::optional< BlobType >	getTargetType () const
	Retrieves the target blob subtype.
BlobOptions &	setTargetType (BlobType value)
	Sets the target blob subtype.
const std::optional< std::int16_t >	getSourceCharSet () const
	Retrieves the source character set identifier.
BlobOptions &	setSourceCharSet (std::int16_t value)
	Sets the source character set identifier.
const std::optional< std::int16_t >	getTargetCharSet () const
	Retrieves the target character set identifier.
BlobOptions &	setTargetCharSet (std::int16_t value)
	Sets the target character set identifier.
const std::optional< BlobStorage >	getStorage () const
	Retrieves the blob storage mode.
BlobOptions &	setStorage (BlobStorage value)
	Sets the blob storage mode.

Detailed Description

Additional options used when creating or opening blobs.

Definition at line 88 of file Blob.h.

Member Function Documentation

getBpb()

const std::vector< std::uint8_t > & fbcpp::BlobOptions::getBpb ( ) const

inlinenoexcept

Retrieves the blob parameter block (BPB) used during blob operations.

Definition at line 94 of file Blob.h.

getSourceCharSet()

const std::optional< std::int16_t > fbcpp::BlobOptions::getSourceCharSet ( ) const

inline

Retrieves the source character set identifier.

Definition at line 171 of file Blob.h.

getSourceType()

const std::optional< BlobType > fbcpp::BlobOptions::getSourceType ( ) const

inline

Retrieves the source blob subtype.

Definition at line 137 of file Blob.h.

getStorage()

const std::optional< BlobStorage > fbcpp::BlobOptions::getStorage ( ) const

inline

Retrieves the blob storage mode.

Definition at line 205 of file Blob.h.

getTargetCharSet()

const std::optional< std::int16_t > fbcpp::BlobOptions::getTargetCharSet ( ) const

inline

Retrieves the target character set identifier.

Definition at line 188 of file Blob.h.

getTargetType()

const std::optional< BlobType > fbcpp::BlobOptions::getTargetType ( ) const

inline

Retrieves the target blob subtype.

Definition at line 154 of file Blob.h.

getType()

const std::optional< BlobType > fbcpp::BlobOptions::getType ( ) const

inline

Retrieves the blob type to be used for blob operations.

Definition at line 120 of file Blob.h.

setBpb() [1/2]

BlobOptions & fbcpp::BlobOptions::setBpb ( const std::vector< std::uint8_t > &  value )

inline

Sets the blob parameter block (BPB) using a copy of the provided value.

Definition at line 102 of file Blob.h.

setBpb() [2/2]

BlobOptions & fbcpp::BlobOptions::setBpb ( std::vector< std::uint8_t > &&  value )

inline

Sets the blob parameter block (BPB) by moving the provided value.

Definition at line 111 of file Blob.h.

setSourceCharSet()

BlobOptions & fbcpp::BlobOptions::setSourceCharSet ( std::int16_t  value )

inline

Sets the source character set identifier.

Definition at line 179 of file Blob.h.

setSourceType()

BlobOptions & fbcpp::BlobOptions::setSourceType ( BlobType  value )

inline

Sets the source blob subtype.

Definition at line 145 of file Blob.h.

setStorage()

BlobOptions & fbcpp::BlobOptions::setStorage ( BlobStorage  value )

inline

Sets the blob storage mode.

Definition at line 213 of file Blob.h.

setTargetCharSet()

BlobOptions & fbcpp::BlobOptions::setTargetCharSet ( std::int16_t  value )

inline

Sets the target character set identifier.

Definition at line 196 of file Blob.h.

setTargetType()

BlobOptions & fbcpp::BlobOptions::setTargetType ( BlobType  value )

inline

Sets the target blob subtype.

Definition at line 162 of file Blob.h.

setType()

BlobOptions & fbcpp::BlobOptions::setType ( BlobType  value )

inline

Sets the blob type to be used for blob operations.

Definition at line 128 of file Blob.h.

---

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

• src/fb-cpp/Blob.h