Класс QBuffer

Класс QBuffer предоставляет интерфейс QIODevice для QByteArray. Подробнее...

• Список всех членов, включая унаследованные

Примечание: Все функции в этом классе являются повторно входящими.

Открытые функции

Переопределённые открытые функции

Переопределённые защищённые функции

Подробное описание

QBuffer позволяет получать доступ к QByteArray с помощью интерфейса QIODevice. QByteArray обрабатывается как стандартный файл с произвольным доступом. Пример:

    QBuffer buffer;
    char ch;

    buffer.open(QBuffer::ReadWrite);
    buffer.write("Qt rocks!");
    buffer.seek(0);
    buffer.getChar(&ch);  // ch == 'Q'
    buffer.getChar(&ch);  // ch == 't'
    buffer.getChar(&ch);  // ch == ' '
    buffer.getChar(&ch);  // ch == 'r'

По умолчанию, внутренний буфер QByteArray создаётся для вас при создании QBuffer. Вы можете напрямую получить доступ к этому буферу, вызвав buffer(). Вы также можете использовать QBuffer с существующим QByteArray, вызвав setBuffer() или передав свой массив в конструктор QBuffer.

Вызовите open(), чтобы открыть буфер. Затем вызовите write() или putChar() для записи в буфер и read(), readLine(), readAll() или getChar() для чтения из него. size() возвращает текущий размер буфера, а вы можете перейти к произвольному положению в буфере, вызвав seek(). Когда вы закончите работу с буфером, вызовите close().

Следующий фрагмент кода демонстрирует, как записать данные в QByteArray с помощью QDataStream и QBuffer:

    QByteArray byteArray;
    QBuffer buffer(&byteArray);
    buffer.open(QIODevice::WriteOnly);

    QDataStream out(&buffer);
    out << QApplication::palette();

По сути, мы преобразуем цветовую палитру приложения QPalette в массив байтов. Вот как считать данные из QByteArray:

    QPalette palette;
    QBuffer buffer(&byteArray);
    buffer.open(QIODevice::ReadOnly);

    QDataStream in(&buffer);
    in >> palette;

QTextStream и QDataStream также предоставляют удобные конструкторы, которые принимают QByteArray и создают QBuffer за кулисами.

QBuffer излучает readyRead(), когда новые данные появились в буфере. Подключив к этому сигналу, вы можете использовать QBuffer для хранения временных данных перед их обработкой. QBuffer также излучает bytesWritten() каждый раз, когда новые данные записываются в буфер.

См. также QFile, QDataStream, QTextStream и QByteArray.

Документация по функциям-членам

QBuffer::QBuffer(QByteArray *byteArray, QObject *parent = nullptr)

Создаёт QBuffer, использующий указанный в byteArray QByteArray как свой внутренний буфер, и с заданным parent. Вызывающий объект несёт ответственность за обеспечение того, чтобы byteArray оставался действительным до уничтожения QBuffer или до вызова setBuffer() для изменения буфера. QBuffer не принимает во владение QByteArray.

Если вы открываете буфер только для записи или для чтения и записи и записываете что-либо в QBuffer, byteArray будет изменён.

Пример:

    QByteArray byteArray("abc");
    QBuffer buffer(&byteArray);
    buffer.open(QIODevice::WriteOnly);
    buffer.seek(3);
    buffer.write("def", 3);
    buffer.close();
    // byteArray == "abcdef"

См. также open(), setBuffer() и setData().

QBuffer::QBuffer(QObject *parent = nullptr)

Создаёт пустой буфер с заданным parent. Вы можете вызвать setData(), чтобы заполнить буфер данными, или открыть его в режиме записи и использовать write().

См. также open().

[virtual] QBuffer::~QBuffer()

Уничтожает буфер.

[override virtual] bool QBuffer::atEnd() const

Переопределяет: QIODevice::atEnd() const.

QByteArray &QBuffer::buffer()

Возвращает ссылку на внутренний буфер QBuffer. Вы можете использовать его для изменения QByteArray за кулисами QBuffer.

См. также setBuffer() и data().

const QByteArray &QBuffer::buffer() const

Это перегруженная функция.

Это то же самое, что и data().

[override virtual] bool QBuffer::canReadLine() const

Переопределяет: QIODevice::canReadLine() const.

[override virtual] void QBuffer::close()

Переопределяет: QIODevice::close().

const QByteArray &QBuffer::data() const

Возвращает данные, содержащиеся в буфере.

Это то же самое, что и buffer().

См. также setData() и setBuffer().

[override virtual] bool QBuffer::open(QIODevice::OpenMode flags)

Переопределяет: QIODevice::open(QIODevice::OpenMode mode).

[override virtual] qint64 QBuffer::pos() const

Переопределяет: QIODevice::pos() const.

[override virtual protected] qint64 QBuffer::readData(char *data, qint64 len)

Переопределяет: QIODevice::readData(char *data, qint64 maxSize).

[override virtual] bool QBuffer::seek(qint64 pos)

Переопределяет: QIODevice::seek(qint64 pos).

void QBuffer::setBuffer(QByteArray *byteArray)

Использует QBuffer указанный в byteArray массив байтов в качестве внутреннего буфера. Ответственность за обеспечение корректности byteArray лежит на вызывающей стороне до тех пор, пока QBuffer не будет уничтожен или не будет вызван метод setBuffer() для изменения буфера. QBuffer не принимает владения над QByteArray.

Не делает ничего, если isOpen() равно true.

Если буфер открыт в режиме записи или чтения/записи и в QBuffer что-то записано, byteArray будет изменён.

Пример:

    QByteArray byteArray("abc");
    QBuffer buffer;
    buffer.setBuffer(&byteArray);
    buffer.open(QIODevice::WriteOnly);
    buffer.seek(3);
    buffer.write("def", 3);
    buffer.close();
    // byteArray == "abcdef"

Если byteArray является nullptr, буфер создаёт собственный внутренний QByteArray для работы. Этот массив байтов изначально пуст.

См. также buffer(), setData() и open().

void QBuffer::setData(const QByteArray &data)

Устанавливает содержимое внутреннего буфера равным data. Это эквивалентно присваиванию data свойству buffer().

Не делает ничего, если isOpen() равно true.

См. также data() и setBuffer().

void QBuffer::setData(const char *data, int size)

Это перегруженный метод.

Устанавливает содержимое внутреннего буфера равным первым size байтам из data.

[override virtual] qint64 QBuffer::size() const

Переопределяет: QIODevice::size() const.

[override virtual protected] qint64 QBuffer::writeData(const char *data, qint64 len)

Переопределяет: QIODevice::writeData(const char *data, qint64 maxSize).