InputStream.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#pragma once

// Headers
#include <SFML/Config.hpp>
 
#include <SFML/System/Export.hpp>
 
#include <optional>
 
#include <cstdint>
 
 
namespace sf
{
class SFML_SYSTEM_API InputStream
{
public:
    virtual ~InputStream() = default;

    [[nodiscard]] virtual std::optional<std::size_t> read(void* data, std::size_t size) = 0;

    [[nodiscard]] virtual std::optional<std::size_t> seek(std::size_t position) = 0;

    [[nodiscard]] virtual std::optional<std::size_t> tell() = 0;

    virtual std::optional<std::size_t> getSize() = 0;
};
 
} // namespace sf