atlas::io::FileStream class
#include <atlas/io/FileStream.h>

Contents

Base classes

class Stream
Handle to a shared eckit::DataHandle.

Derived classes

class InputFileStream
class OutputFileStream

Constructors, destructors, conversion operators

FileStream(const eckit::PathName& path, Mode openmode)
FileStream(const eckit::PathName& path, char openmode)
FileStream(const eckit::PathName& path, const std::string& openmode)
operator bool() const
Return true if pointer is valid;.

Public functions

auto datahandle() -> eckit::DataHandle&
Access internal eckit::DataHandle.
auto seek(std::uint64_t offset) -> std::uint64_t
Move position to given offset.
auto position() -> std::uint64_t
Return offset of current position.
auto write(const void* data, size_t length) -> std::uint64_t
auto read(void* data, size_t length) -> std::uint64_t

Function documentation

atlas::io::FileStream::operator bool() const
#include <atlas/io/Stream.h>

Return true if pointer is valid;.

eckit::DataHandle& atlas::io::FileStream::datahandle()
#include <atlas/io/Stream.h>

Access internal eckit::DataHandle.

std::uint64_t atlas::io::FileStream::seek(std::uint64_t offset)
#include <atlas/io/Stream.h>

Move position to given offset.

std::uint64_t atlas::io::FileStream::position()
#include <atlas/io/Stream.h>

Return offset of current position.

std::uint64_t atlas::io::FileStream::write(const void* data, size_t length)
#include <atlas/io/Stream.h>

Returns number of bytes written

Write data of given length (bytes)

std::uint64_t atlas::io::FileStream::read(void* data, size_t length)
#include <atlas/io/Stream.h>

Returns number of bytes read

Read data of given length (bytes)