oRTP
0.27.0
|
Data Structures | |
struct | b64ErrorString_t_ |
Typedefs | |
typedef struct b64ErrorString_t_ | b64ErrorString_t_ |
Functions | |
size_t | b64_encode (void const *src, size_t srcSize, char *dest, size_t destLen) |
Encodes a block of binary data into Base-64. More... | |
size_t | b64_encode2 (void const *src, size_t srcSize, char *dest, size_t destLen, unsigned flags, int lineLen, B64_RC *rc) |
Encodes a block of binary data into Base-64. More... | |
size_t | b64_decode (char const *src, size_t srcLen, void *dest, size_t destSize) |
Decodes a sequence of Base-64 into a block of binary data. More... | |
size_t | b64_decode2 (char const *src, size_t srcLen, void *dest, size_t destSize, unsigned flags, char const **badChar, B64_RC *rc) |
Decodes a sequence of Base-64 into a block of binary data. More... | |
char const * | b64_getErrorString (B64_RC code) |
Returns the textual description of the error. More... | |
size_t | b64_getErrorStringLength (B64_RC code) |
Returns the length of the textual description of the error. More... | |
Implementation file for the b64 library
#define SEVERITY_STR_DECL | ( | rc, | |
desc | |||
) |
#define SEVERITY_STR_ENTRY | ( | rc | ) |
size_t b64_decode | ( | char const * | src, |
size_t | srcLen, | ||
void * | dest, | ||
size_t | destSize | ||
) |
Decodes a sequence of Base-64 into a block of binary data.
src | Pointer to the Base-64 block to be decoded. May not be NULL, except when dest is NULL, in which case it is ignored. If dest is NULL, and src is not NULL, then the returned value is calculated exactly, otherwise a value is returned that is guaranteed to be large enough to hold the decoded block. |
srcLen | Length of block to be encoded. Must be an integral of 4, the Base-64 encoding quantum, otherwise the Base-64 block is assumed to be invalid |
dest | Pointer to the buffer into which the result is to be written. May be NULL, in which case the function returns the required length |
destSize | Length of the buffer into which the result is to be written. Must be at least as large as that indicated by the return value from b64_decode(src, srcSize, NULL, 0) , even in the case where the encoded form contains a number of characters that will be ignored, resulting in a lower total length of converted form. |
destSize
dest
is NULL. The returned size might be larger than the actual required size, but will never be smaller.size_t b64_decode2 | ( | char const * | src, |
size_t | srcLen, | ||
void * | dest, | ||
size_t | destSize, | ||
unsigned | flags, | ||
char const ** | badChar, | ||
B64_RC * | rc | ||
) |
Decodes a sequence of Base-64 into a block of binary data.
src | Pointer to the Base-64 block to be decoded. May not be NULL, except when dest is NULL, in which case it is ignored. If dest is NULL, and src is not NULL, then the returned value is calculated exactly, otherwise a value is returned that is guaranteed to be large enough to hold the decoded block. |
srcLen | Length of block to be encoded. Must be an integral of 4, the Base-64 encoding quantum, otherwise the Base-64 block is assumed to be invalid |
dest | Pointer to the buffer into which the result is to be written. May be NULL, in which case the function returns the required length |
destSize | Length of the buffer into which the result is to be written. Must be at least as large as that indicated by the return value from b64_decode(src, srcSize, NULL, 0) , even in the case where the encoded form contains a number of characters that will be ignored, resulting in a lower total length of converted form. |
flags | A combination of the B64_FLAGS enumeration, that moderate the behaviour of the function. |
rc | The return code representing the status of the operation. May be NULL. |
badChar | If the flags parameter does not contain B64_F_STOP_ON_NOTHING, this parameter specifies the address of a pointer that will be set to point to any character in the sequence that stops the parsing, as dictated by the flags parameter. May be NULL. |
destSize
, or a bad character stopped parsing.dest
is NULL. The returned size might be larger than the actual required size, but will never be smaller.size_t b64_encode | ( | void const * | src, |
size_t | srcSize, | ||
char * | dest, | ||
size_t | destLen | ||
) |
Encodes a block of binary data into Base-64.
src | Pointer to the block to be encoded. May not be NULL, except when dest is NULL, in which case it is ignored. |
srcSize | Length of block to be encoded |
dest | Pointer to the buffer into which the result is to be written. May be NULL, in which case the function returns the required length |
destLen | Length of the buffer into which the result is to be written. Must be at least as large as that indicated by the return value from b64_encode(NULL, srcSize, NULL, 0). |
destLen
dest
is NULLdest
is NULL. The returned size might be larger than the actual required size, but will never be smaller.size_t b64_encode2 | ( | void const * | src, |
size_t | srcSize, | ||
char * | dest, | ||
size_t | destLen, | ||
unsigned | flags, | ||
int | lineLen, | ||
B64_RC * | rc | ||
) |
Encodes a block of binary data into Base-64.
src | Pointer to the block to be encoded. May not be NULL, except when dest is NULL, in which case it is ignored. |
srcSize | Length of block to be encoded |
dest | Pointer to the buffer into which the result is to be written. May be NULL, in which case the function returns the required length |
destLen | Length of the buffer into which the result is to be written. Must be at least as large as that indicated by the return value from b64_encode2(NULL, srcSize, NULL, 0, flags, lineLen, rc). |
flags | A combination of the B64_FLAGS enumeration, that moderate the behaviour of the function |
lineLen | If the flags parameter contains B64_F_LINE_LEN_USE_PARAM, then this parameter represents the length of the lines into which the encoded form is split, with a hard line break ('\r\n'). If this value is 0, then the line is not split. If it is <0, then the RFC-1113 recommended line length of 64 is used |
rc | The return code representing the status of the operation. May be NULL. |
destLen
dest
is NULL. The returned size might be larger than the actual required size, but will never be smaller.char const* b64_getErrorString | ( | B64_RC | code | ) |
Returns the textual description of the error.
code | The error code |
size_t b64_getErrorStringLength | ( | B64_RC | code | ) |
Returns the length of the textual description of the error.
code | The error code |