FSD_Base64 Class Reference

Tool for encoding/decoding base64 stream. More...

#include <FSD_Base64.hxx>

Static Public Member Functions
static size_t	Encode (char *theEncodedStr, const size_t theStrLen, const uint8_t *theData, const size_t theDataLen)
	Function encoding a buffer to base64 string.
static TCollection_AsciiString	Encode (const uint8_t *theData, const size_t theDataLen)
	Function encoding a buffer to base64 string.
static size_t	Decode (uint8_t *theDecodedData, const size_t theDataLen, const char *theEncodedStr, const size_t theStrLen)
	Function decoding base64 string.
static occ::handle< NCollection_Buffer >	Decode (const char *theStr, const size_t theLen)
	Function decoding base64 string.

Detailed Description

Tool for encoding/decoding base64 stream.

Member Function Documentation

Decode() [1/2]

static occ::handle< NCollection_Buffer > FSD_Base64::Decode ( const char * theStr, const size_t theLen )

static

Function decoding base64 string.

Parameters

[in]	theStr	the input encoded string
[in]	theLen	the length of input encoded string

Returns

null handle in case of out of memory condition

Decode() [2/2]

static size_t FSD_Base64::Decode ( uint8_t * theDecodedData, const size_t theDataLen, const char * theEncodedStr, const size_t theStrLen )

static

Function decoding base64 string.

Parameters

[out]	theDecodedData	the place for decoded data. If it is NULL just return the needed size.
[in]	theDataLen	the length of the buffer theDecodedData in bytes. This value must not be less than value returned when theDecodedData is NULL.
[in]	theEncodedStr	the input encoded string.
[in]	theStrLen	the length of input encoded string.

Returns

the length of the decoded data in bytes. If theDataLen is not enough for storing all data nothing is written and 0 is returned.

Encode() [1/2]

static size_t FSD_Base64::Encode ( char * theEncodedStr, const size_t theStrLen, const uint8_t * theData, const size_t theDataLen )

static

Function encoding a buffer to base64 string.

Parameters

[out]	theEncodedStr	the place for encoded string. Terminating null is not put. If it is NULL just return the needed size.
[in]	theStrLen	the length of the buffer theEncodedStr in bytes. This value must not be less than value returned when theEncodedStr is NULL.
[in]	theData	the input binary data.
[in]	theDataLen	the length of input data in bytes.

Returns

the length of the encoded string not including terminating null. If theStrLen is not enough for storing all data nothing is written and 0 is returned.

Encode() [2/2]

static TCollection_AsciiString FSD_Base64::Encode ( const uint8_t * theData, const size_t theDataLen )

static

Function encoding a buffer to base64 string.

Parameters

[in]	theData	the input binary data
[in]	theDataLen	the length of input data in bytes

Returns

Base64 encoded string.

---

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

• FSD_Base64.hxx