QStringEncoder Class
La clase QStringEncoder proporciona un codificador de texto basado en estados. Más información...
| Encabezado: | #include <QStringEncoder> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Core) target_link_libraries(mytarget PRIVATE Qt6::Core) |
| qmake: | QT += core |
| Heredan: | QStringConverter |
- Lista de todos los miembros, incluidos los heredados
- QStringEncoder forma parte de las clases para datos de cadena.
Nota: Todas las funciones de esta clase son reentrantes.
Tipos públicos
Funciones públicas
| QStringEncoder() | |
| QStringEncoder(QAnyStringView name, QStringConverter::Flags flags = Flag::Default) | |
| QStringEncoder(QStringConverter::Encoding encoding, QStringConverter::Flags flags = Flag::Default) | |
| char * | appendToBuffer(char *out, QStringView in) |
| QStringEncoder::DecodedData<QStringView> | encode(QStringView in) |
| QStringEncoder::DecodedData<const QString &> | encode(const QString &in) |
(since 6.11) QStringEncoder::FinalizeResult | finalize() |
(since 6.11) QStringEncoder::FinalizeResult | finalize(char *out, qsizetype maxlen) |
| qsizetype | requiredSpace(qsizetype inputLength) const |
| QStringEncoder::DecodedData<QStringView> | operator()(QStringView in) |
| QStringEncoder::DecodedData<const QString &> | operator()(const QString &in) |
Descripción detallada
Un codificador de texto convierte el texto de la representación interna de Qt a un formato de texto codificado utilizando una codificación específica.
La conversión de una cadena de Unicode a la codificación local se puede realizar mediante el siguiente código:
QString string = "...";
auto fromUtf16 = QStringEncoder(QStringEncoder::Utf8);
QByteArray encodedString = fromUtf16(string);El codificador recuerda cualquier estado necesario entre llamadas, por lo que convertir datos recibidos en fragmentos —por ejemplo, al recibirlos a través de una red— resulta igual de sencillo, llamando al codificador cada vez que haya nuevos datos disponibles:
auto fromUtf16 = QStringEncoder(QStringEncoder::Utf8);
QByteArray encoded;
while (new_data_available() && !fromUtf16.hasError()) {
QString chunk = get_new_data();
encoded += fromUtf16(chunk);
}
auto result = fromUtf16.finalize();
if (result.error != QStringEncoder::FinalizeResult::Error::NoError) {
// Handle error
}El objeto QStringEncoder mantiene el estado entre fragmentos y, por lo tanto, funciona correctamente incluso si un carácter sustituto UTF-16 se divide entre fragmentos.
Los objetos QStringEncoder no se pueden copiar debido a su estado interno, pero sí se pueden mover.
Véase también QStringConverter y QStringDecoder.
Documentación de los tipos de miembros
[alias] QStringEncoder::FinalizeResult
Este es un alias de « QStringConverter::FinalizeResultChar<char>».
Documentación de funciones de miembro
[constexpr noexcept] QStringEncoder::QStringEncoder()
«Default» crea un codificador. El codificador predeterminado no es válido y no se puede utilizar para convertir texto.
[explicit] QStringEncoder::QStringEncoder(QAnyStringView name, QStringConverter::Flags flags = Flag::Default)
Crea un objeto codificador utilizando name y flags. Si name no es el nombre de una codificación conocida, se creará un conversor no válido.
Nota: En las versiones de Qt anteriores a la 6.8, esta función solo aceptaba un ` const char *`, que se esperaba que estuviera codificado en UTF-8.
Véase también isValid().
[explicit constexpr] QStringEncoder::QStringEncoder(QStringConverter::Encoding encoding, QStringConverter::Flags flags = Flag::Default)
Crea un objeto codificador utilizando encoding y flags.
char *QStringEncoder::appendToBuffer(char *out, QStringView in)
Codifica in y escribe el resultado codificado en el búfer a partir de out. Devuelve un puntero al final de los datos escritos.
Nota: out debe tener un tamaño suficiente para poder almacenar todos los datos descodificados. Utiliza requiredSpace() para determinar el tamaño máximo necesario para poder codificar in. Esta función puede escribir en cualquier byte entre out y out + requiredSpace(), incluidos aquellos que se encuentren más allá del puntero final devuelto.
Véase también requiredSpace().
QStringEncoder::DecodedData<QStringView> QStringEncoder::encode(QStringView in)
QStringEncoder::DecodedData<QStringView> QStringEncoder::operator()(QStringView in)
QStringEncoder::DecodedData<const QString &> QStringEncoder::encode(const QString &in)
QStringEncoder::DecodedData<const QString &> QStringEncoder::operator()(const QString &in)
Convierte ` in ` y devuelve una estructura que se puede convertir implícitamente a ` QByteArray`.
QString string = "...";
auto fromUtf16 = QStringEncoder(QStringEncoder::Utf8);
auto data = fromUtf16(string); // data's type is QStringEncoder::DecodedData<const QString &>
QByteArray encodedString = fromUtf16(string); // Implicit conversion to QByteArray
// Here you have to cast "data" to QByteArray
auto func = [&]() { return !fromUtf16.hasError() ? QByteArray(data) : "foo"_ba; };[since 6.11] QStringEncoder::FinalizeResult QStringEncoder::finalize()
[since 6.11] QStringEncoder::FinalizeResult QStringEncoder::finalize(char *out, qsizetype maxlen)
Indica al decodificador que no llegarán más datos.
También puede proporcionar datos del contenido residual que estaba pendiente de decodificación. Cuando no haya datos residuales que tener en cuenta, el campo « error » de la respuesta se establecerá en « NoError ».
Si se proporciona out y no es nulo, debe disponer de espacio en el que se puedan escribir hasta maxlen caracteres. Se escriben en este espacio hasta ese número de caracteres de salida residual, indicándose el final mediante el campo next del valor de retorno. Normalmente, estos datos residuales consistirán en un carácter de sustitución por cada carácter de entrada no convertido restante. Cuando se utiliza una codificación con estado, como ISO-2022-JP, también pueden escribirse bytes para restaurar o finalizar el estado actual en el flujo de caracteres.
Si todo el contenido residual se ha entregado mediante ` out`, si ` out ` es ` nullptr` o si no hay datos residuales, el decodificador se restablece al regresar de ` finalize()`. De lo contrario, los datos restantes pueden recuperarse o descartarse mediante una nueva llamada a ` finalize()`.
Estas funciones se introdujeron en Qt 6.11.
Véanse también hasError() y appendToBuffer().
qsizetype QStringEncoder::requiredSpace(qsizetype inputLength) const
Devuelve el número máximo de caracteres necesarios para poder procesar los datos descodificados de inputLength.
Véase también appendToBuffer().
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.