Loading...
Searching...
No Matches
InputStream.hpp
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#pragma once
26
28// Headers
30#include <SFML/Config.hpp>
31
32#include <SFML/System/Export.hpp>
33
34#include <optional>
35
36#include <cstdint>
37
38
39namespace sf
40{
45class SFML_SYSTEM_API InputStream
46{
47public:
52 virtual ~InputStream() = default;
53
66 [[nodiscard]] virtual std::optional<std::size_t> read(void* data, std::size_t size) = 0;
67
76 [[nodiscard]] virtual std::optional<std::size_t> seek(std::size_t position) = 0;
77
84 [[nodiscard]] virtual std::optional<std::size_t> tell() = 0;
85
92 virtual std::optional<std::size_t> getSize() = 0;
93};
94
95} // namespace sf
96
97
SFML_SYSTEM_API
#define SFML_SYSTEM_API
Definition System/Export.hpp:42
sf::InputStream
Abstract class for custom file input streams.
Definition InputStream.hpp:46
sf::InputStream::tell
virtual std::optional< std::size_t > tell()=0
Get the current reading position in the stream.
sf::InputStream::getSize
virtual std::optional< std::size_t > getSize()=0
Return the size of the stream.
sf::InputStream::read
virtual std::optional< std::size_t > read(void *data, std::size_t size)=0
Read data from the stream.
sf::InputStream::seek
virtual std::optional< std::size_t > seek(std::size_t position)=0
Change the current reading position.
sf::InputStream::~InputStream
virtual ~InputStream()=default
Virtual destructor.