File stream class. More...

#include <FileStream.h>

Inheritance diagram for sese::io::FileStream:

Public Types
using	Ptr = std::shared_ptr<FileStream>

Public Types inherited from sese::io::Stream
typedef std::shared_ptr< Stream >	Ptr

Public Types inherited from sese::io::InputStream
typedef std::shared_ptr< InputStream >	Ptr

Public Types inherited from sese::io::OutputStream
typedef std::shared_ptr< OutputStream >	Ptr

Public Types inherited from sese::io::PeekableStream
typedef std::shared_ptr< PeekableStream >	Ptr

Public Member Functions
	~FileStream () override=default

int64_t	read (void *buffer, size_t length) override

int64_t	write (const void *buffer, size_t length) override

void	close () override

int64_t	peek (void *buffer, size_t length) override

int64_t	trunc (size_t length) override

bool	eof () const

int64_t	getSeek () const

int32_t	setSeek (int64_t offset, int32_t whence) const

int32_t	setSeek (int64_t offset, Seek type) const

int32_t	flush () const

int32_t	getFd () const

Public Member Functions inherited from sese::io::InputStream
virtual	~InputStream () noexcept=default

Public Member Functions inherited from sese::io::OutputStream
virtual	~OutputStream () noexcept=default

int64_t	write (const std::string_view &buffer)

int64_t	write (const text::StringView &buffer)

template<typename T >
int64_t	write (std::vector< T > &buffer)

template<typename T , size_t N>
int64_t	write (std::array< T, N > &buffer)

Public Member Functions inherited from sese::io::Closeable
virtual	~Closeable ()=default

Public Member Functions inherited from sese::io::PeekableStream
virtual	~PeekableStream ()=default

Static Public Member Functions
static FileStream::Ptr	create (const std::string &file_path, const char *mode) noexcept

static FileStream::Ptr	createWithPath (const system::Path &path, const char *mode) noexcept

static Result< Ptr, ErrorCode >	createEx (const std::string &file_path, const char *mode) noexcept

Static Public Attributes
static constexpr auto	B_READ = "rb"

static constexpr auto	B_WRITE_TRUNC = "wb"

static constexpr auto	B_WRITE_APPEND = "ab"

static constexpr auto	B_TRUNC = "wb+"

static constexpr auto	B_APPEND = "ab+"

static constexpr auto	T_READ = "rt"

static constexpr auto	T_WRITE_TRUNC = "wt"

static constexpr auto	T_WRITE_APPEND = "at"

static constexpr auto	T_TRUNC = "wt+"

static constexpr auto	T_APPEND = "at+"

Private Member Functions
	FileStream () noexcept=default

Private Attributes
FILE *	file = nullptr

Detailed Description

File stream class.

Member Typedef Documentation

◆ Ptr

using sese::io::FileStream::Ptr = std::shared_ptr<FileStream>

Constructor & Destructor Documentation

◆ ~FileStream()

sese::io::FileStream::~FileStream ( )

overridedefault

◆ FileStream()

sese::io::FileStream::FileStream ( )

privatedefaultnoexcept

Member Function Documentation

◆ close()

void FileStream::close ( )

overridevirtual

Implements sese::io::Closeable.

References file.

◆ create()

FileStream::Ptr FileStream::create	(	const std::string &	file_path,
		const char *	mode )

staticnoexcept

Open a file stream

Parameters

file_path	File path
mode	Open mode

Return values

nullptr	Failed to open
File	stream object

References MAKE_SHARED_PRIVATE.

Referenced by sese::archive::ArchiveWriter::addDirectory(), sese::archive::ArchiveWriter::addFile(), sese::record::BlockAppender::BlockAppender(), sese::text::TextReader::create(), sese::UniReader::create(), createWithPath(), sese::record::BlockAppender::dump(), and sese::internal::service::http::HttpServiceImpl::handleRequest().

◆ createEx()

sese::Result< FileStream::Ptr, sese::ErrorCode > FileStream::createEx	(	const std::string &	file_path,
		const char *	mode )

staticnoexcept

References sese::getErrorCode(), and sese::getErrorString().

◆ createWithPath()

FileStream::Ptr FileStream::createWithPath	(	const system::Path &	path,
		const char *	mode )

staticnoexcept

Open a file in UNIX-LIKE style

Parameters

path	UNIX-LIKE path
mode	Open mode

Return values

nullptr Failed to open

References create().

◆ eof()

bool FileStream::eof ( ) const

nodiscard

This function is used to determine if the end of the file has been reached

Warning: This requires an initial read failure to obtain a valid value

Returns: Result

References file.

◆ flush()

int32_t FileStream::flush ( ) const

nodiscard

References file.

◆ getFd()

int32_t FileStream::getFd ( ) const

nodiscard

References file.

◆ getSeek()

int64_t FileStream::getSeek ( ) const

nodiscard

References file.

◆ peek()

int64_t FileStream::peek	(	void *	buffer,
		size_t	length )

overridevirtual

Read content without stepping

Parameters

buffer	Buffer
length	Buffer size

Returns: Actual size read

Implements sese::io::PeekableStream.

References sese::io::CUR, read(), and setSeek().

◆ read()

int64_t FileStream::read	(	void *	buffer,
		size_t	length )

overridevirtual

Implements sese::io::InputStream.

References file.

Referenced by peek().

◆ setSeek() [1/2]

int32_t FileStream::setSeek	(	int64_t	offset,
		int32_t	whence ) const

nodiscard

References file.

Referenced by peek(), and trunc().

◆ setSeek() [2/2]

int32_t FileStream::setSeek	(	int64_t	offset,
		Seek	type ) const

nodiscard

References file.

◆ trunc()

int64_t FileStream::trunc ( size_t length )

overridevirtual

Step only, without reading content

Parameters

length Step size

Returns: Actual step size

Implements sese::io::PeekableStream.

References sese::io::CUR, file, and setSeek().

◆ write()

int64_t FileStream::write	(	const void *	buffer,
		size_t	length )

overridevirtual

Implements sese::io::OutputStream.

References file.

Member Data Documentation

◆ B_APPEND

auto sese::io::FileStream::B_APPEND = "ab+"

staticconstexpr

◆ B_READ

auto sese::io::FileStream::B_READ = "rb"

staticconstexpr

Referenced by sese::archive::ArchiveWriter::addDirectory(), sese::archive::ArchiveWriter::addFile(), and sese::internal::service::http::HttpServiceImpl::handleRequest().

◆ B_TRUNC

auto sese::io::FileStream::B_TRUNC = "wb+"

staticconstexpr

◆ B_WRITE_APPEND

auto sese::io::FileStream::B_WRITE_APPEND = "ab"

staticconstexpr

◆ B_WRITE_TRUNC

auto sese::io::FileStream::B_WRITE_TRUNC = "wb"

staticconstexpr

Referenced by sese::archive::ArchiveReader::extract().

◆ file

FILE* sese::io::FileStream::file = nullptr

private

Referenced by close(), eof(), flush(), getFd(), getSeek(), read(), setSeek(), setSeek(), trunc(), and write().

◆ T_APPEND

auto sese::io::FileStream::T_APPEND = "at+"

staticconstexpr

◆ T_READ

auto sese::io::FileStream::T_READ = "rt"

staticconstexpr

Referenced by sese::text::TextReader::create(), and sese::UniReader::create().

◆ T_TRUNC

auto sese::io::FileStream::T_TRUNC = "wt+"

staticconstexpr

◆ T_WRITE_APPEND

auto sese::io::FileStream::T_WRITE_APPEND = "at"

staticconstexpr

◆ T_WRITE_TRUNC

auto sese::io::FileStream::T_WRITE_TRUNC = "wt"

staticconstexpr

Referenced by sese::record::BlockAppender::BlockAppender(), and sese::record::BlockAppender::dump().

The documentation for this class was generated from the following files:

sese/io/FileStream.h
sese/io/FileStream.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ ~FileStream()

◆ FileStream()

Member Function Documentation

◆ close()

◆ create()

◆ createEx()

◆ createWithPath()

◆ eof()

◆ flush()

◆ getFd()

◆ getSeek()

◆ peek()

◆ read()

◆ setSeek() [1/2]

◆ setSeek() [2/2]

◆ trunc()

◆ write()

Member Data Documentation

◆ B_APPEND

◆ B_READ

◆ B_TRUNC

◆ B_WRITE_APPEND

◆ B_WRITE_TRUNC

◆ file

◆ T_APPEND

◆ T_READ

◆ T_TRUNC

◆ T_WRITE_APPEND

◆ T_WRITE_TRUNC