mirror of
https://github.com/kidfromjupiter/nearby.git
synced 2026-09-15 07:06:11 -04:00
54 lines
1.7 KiB
C++
54 lines
1.7 KiB
C++
// Copyright 2020 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// https://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
#ifndef PLATFORM_BASE_INPUT_STREAM_H_
|
|
#define PLATFORM_BASE_INPUT_STREAM_H_
|
|
|
|
#include <cstddef>
|
|
#include <cstdint>
|
|
|
|
#include "internal/platform/byte_array.h"
|
|
#include "internal/platform/exception.h"
|
|
|
|
namespace nearby {
|
|
|
|
// An InputStream represents an input stream of bytes.
|
|
//
|
|
// https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html
|
|
class InputStream {
|
|
public:
|
|
virtual ~InputStream() = default;
|
|
|
|
// Reads at most `size` bytes from the input stream.
|
|
// Returns an empty byte array on end of file, or Exception::kIo on error.
|
|
virtual ExceptionOr<ByteArray> Read(std::int64_t size) = 0;
|
|
|
|
// Skips `offset` bytes from the stream.
|
|
// Returns the number of bytes skipped, which can be less than offset on EOF,
|
|
// or Exception::kIo on error.
|
|
virtual ExceptionOr<size_t> Skip(size_t offset);
|
|
|
|
// Reads exactly `size` bytes from the input stream.
|
|
// Return Exception::kIo on error, or if end of file is reached before reading
|
|
// `size` bytes.
|
|
ExceptionOr<ByteArray> ReadExactly(std::size_t size);
|
|
|
|
// throws Exception::kIo
|
|
virtual Exception Close() = 0;
|
|
};
|
|
|
|
} // namespace nearby
|
|
|
|
#endif // PLATFORM_BASE_INPUT_STREAM_H_
|