develop/AByteBufferInputStream_8h_source.html

/*

 * AUI Framework - Declarative UI toolkit for modern C++20

 * Copyright (C) 2020-2025 Alex2772 and Contributors

 *

 * SPDX-License-Identifier: MPL-2.0

 *

 * This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/.

 */


#pragma once

#include "IInputStream.h"

#include "ISeekableInputStream.h"

#include "AUI/Common/AByteBuffer.h"

#include "AUI/Common/SharedPtr.h"


class API_AUI_CORE AByteBufferInputStream final : public ISeekableInputStream {

private:

    const char* mBegin;

    const char* mEnd;

    const char* mCurrent;


public:

    AByteBufferInputStream(AByteBufferView buffer) : mBegin(buffer.data()), mEnd(buffer.data() + buffer.size()), mCurrent(mBegin) {}

    ~AByteBufferInputStream() override = default;

    void seek(std::streamoff offset, ASeekDir seekDir) override;

    [[nodiscard]] std::streampos tell() noexcept override;

    bool isEof() override;


    size_t read(char* dst, size_t size) override;


    size_t available() const { return mEnd - mCurrent; }

};


AByteBufferInputStream::tell
std::streampos tell() noexcept override
return current reading position

AByteBufferInputStream::read
size_t read(char *dst, size_t size) override
Reads up to size bytes from stream. Blocking (waiting for new data) is allowed.

AByteBufferInputStream::seek
void seek(std::streamoff offset, ASeekDir seekDir) override
change reading position, a way of changing depends on seekDir parameter

AByteBufferInputStream::isEof
bool isEof() override
returns true if end of stream has been reached

AByteBufferView
Acts like std::string_view but for AByteBuffer.
Definition AByteBufferView.h:24

ISeekableInputStream
Represents an input stream with updating reading position.
Definition ISeekableInputStream.h:27