Member Function Documentation

[static] KCodecs::Codec *Codec::codecForName(QByteArrayView name)

Returns a codec associated with the specified name.

name is a valid codec name.

QByteArray Codec::decode(QByteArrayView src, KCodecs::Codec::NewlineType newline = NewlineLF) const

Even more convenient, but also a bit slower and more memory intensive, since it allocates storage for the worst case and then shrinks the result QByteArray to the actual size again.

For use with small src.

src is the data to decode.

newline whether make new lines using CRLF, or LF (default is LF).

[virtual] bool Codec::decode(const char *&scursor, const char *const send, char *&dcursor, const char *const dend, KCodecs::Codec::NewlineType newline = NewlineLF) const

Convenience wrapper that can be used for small chunks of data when you can provide a large enough buffer. The default implementation creates a Decoder and uses it.

Decodes a chunk of bytes starting at scursor and extending to send into the buffer described by dcursor and dend.

This function doesn't support chaining of blocks. The returned block cannot be added to, but you don't need to finalize it, too.

Example usage (in contains the input data):

KCodecs::Codec *codec = KCodecs::Codec::codecForName("base64");
if (!codec) {
    qFatal() << "no base64 codec found!?";
}
QByteArray out(in.size()); // good guess for any encoding...
QByteArray::Iterator iit = in.begin();
QByteArray::Iterator oit = out.begin();
if (!codec->decode(iit, in.end(), oit, out.end())) {
    qDebug() << "output buffer too small";
    return;
}
qDebug() << "Size of decoded data:" << oit - out.begin();

scursor is a pointer to the start of the input buffer.

send is a pointer to the end of the input buffer.

dcursor is a pointer to the start of the output buffer.

dend is a pointer to the end of the output buffer.

newline whether make new lines using CRLF, or LF (default is LF).

Returns false if the decoded data didn't fit into the output buffer; true otherwise.

QByteArray Codec::encode(QByteArrayView src, KCodecs::Codec::NewlineType newline = NewlineLF) const

Even more convenient, but also a bit slower and more memory intensive, since it allocates storage for the worst case and then shrinks the result QByteArray to the actual size again.

For use with small src.

src is the data to encode.

newline whether make new lines using CRLF, or LF (default is LF).

[virtual] bool Codec::encode(const char *&scursor, const char *const send, char *&dcursor, const char *const dend, KCodecs::Codec::NewlineType newline = NewlineLF) const

Convenience wrapper that can be used for small chunks of data when you can provide a large enough buffer. The default implementation creates an Encoder and uses it.

Encodes a chunk of bytes starting at scursor and extending to send into the buffer described by dcursor and dend.

This function doesn't support chaining of blocks. The returned block cannot be added to, but you don't need to finalize it, too.

Example usage (in contains the input data):

KCodecs::Codec *codec = KCodecs::Codec::codecForName("base64");
if (!codec) {
    qFatal() << "no base64 codec found!?";
}
QByteArray out(in.size() * 1.4); // crude maximal size of b64 encoding
QByteArray::Iterator iit = in.begin();
QByteArray::Iterator oit = out.begin();
if (!codec->encode(iit, in.end(), oit, out.end())) {
    qDebug() << "output buffer too small";
    return;
}
qDebug() << "Size of encoded data:" << oit - out.begin();

scursor is a pointer to the start of the input buffer.

send is a pointer to the end of the input buffer.

dcursor is a pointer to the start of the output buffer.

dend is a pointer to the end of the output buffer.

newline whether make new lines using CRLF, or LF (default is LF).

Returns false if the encoded data didn't fit into the output buffer; true otherwise.

[pure virtual] KCodecs::Decoder *Codec::makeDecoder(KCodecs::Codec::NewlineType newline = NewlineLF) const

Creates the decoder for the codec.

newline whether make new lines using CRLF, or LF (default is LF).

Returns a pointer to an instance of the codec's decoder.

[pure virtual] KCodecs::Encoder *Codec::makeEncoder(KCodecs::Codec::NewlineType newline = NewlineLF) const

Creates the encoder for the codec.

newline whether make new lines using CRLF, or LF (default is LF).

Returns a pointer to an instance of the codec's encoder.

[pure virtual] qsizetype Codec::maxDecodedSizeFor(qsizetype insize, KCodecs::Codec::NewlineType newline = NewlineLF) const

Computes the maximum size, in characters, needed for the deccoding.

insize is the number of input characters to be decoded.

newline whether make new lines using CRLF, or LF (default is LF).

Returns the maximum number of characters in the decoding.

[pure virtual] qsizetype Codec::maxEncodedSizeFor(qsizetype insize, KCodecs::Codec::NewlineType newline = NewlineLF) const

Computes the maximum size, in characters, needed for the encoding.

insize is the number of input characters to be encoded.

newline whether make new lines using CRLF, or LF (default is LF).

Returns the maximum number of characters in the encoding.

[pure virtual] const char *Codec::name() const

Returns the name of the encoding. Guaranteed to be lowercase.