AuroraRuntime/Include/Aurora/IO/IIOBufferedStreamAvailable.hpp

/***
    Copyright (C) 2022 J Reece Wilson (a/k/a "Reece"). All rights reserved.

    File: IBufferedStreamAvailable.hpp
    Date: 2022-6-20
    Author: Reece
***/
#pragma once

namespace Aurora::IO
{
    struct IIOPipeInterceptor;

    AUKN_INTERFACE(IIOBufferedStreamAvailable,
        /**
         * @brief
         * @return false Restores the read head. This will not stop further callbacks until the IOWorkItem is explicitly aborted.
         *         true  Nothing. If you moved the read head forward, you must return true to prevent roll-back.
        */
        AUI_METHOD(bool, OnDataAvailable, (Memory::ByteBuffer &, view))
    );
}