ufo::ReadBuffer Class Reference

Inheritance diagram for ufo::ReadBuffer:

Public Types
using	offset_type = BaseBuffer::offset_type
using	pos_type = BaseBuffer::pos_type
using	size_type = BaseBuffer::size_type
Public Types inherited from ufo::BaseBuffer
using	offset_type = std::intmax_t
using	pos_type = std::uintmax_t
using	size_type = std::size_t

Public Member Functions
	ReadBuffer (std::byte const *data, size_type count)
ReadBuffer &	read (std::ostream &out, size_type count)
template<class T >
ReadBuffer &	read (T &t)
ReadBuffer &	read (void *dest, size_type count)
void	readAt (offset_type off, IODir dir, std::ostream &out, size_type count) const
template<class T >
void	readAt (offset_type off, IODir dir, T &t) const
void	readAt (offset_type off, IODir dir, void *dest, size_type count) const
void	readAt (pos_type pos, std::ostream &out, size_type count) const
template<class T >
void	readAt (pos_type pos, T &t) const
void	readAt (pos_type pos, void *dest, size_type count) const
size_type	readLeft () const noexcept
bool	readLine (std::string &line)
pos_type	readPos () const noexcept
ReadBuffer &	readSeek (offset_type off, IODir dir) noexcept
ReadBuffer &	readSeek (pos_type pos) noexcept
template<class T >
ReadBuffer &	readSeek (T const &t, offset_type count_signed, IODir dir) noexcept
template<class T >
ReadBuffer &	readSeek (T const &t, pos_type count) noexcept
Public Member Functions inherited from ufo::BaseBuffer
constexpr std::byte const *	data () const noexcept
constexpr bool	empty () const noexcept
constexpr size_type	size () const noexcept

Protected Attributes
pos_type	pos_ {}
Protected Attributes inherited from ufo::BaseBuffer
std::byte const *	data_ = nullptr
size_type	size_ {}

Additional Inherited Members
Protected Member Functions inherited from ufo::BaseBuffer
constexpr	BaseBuffer (std::byte const *data, size_type size)
constexpr pos_type	pos (pos_type pos, offset_type off, IODir dir) const noexcept

Detailed Description

Definition at line 55 of file read_buffer.hpp.

Member Typedef Documentation

offset_type

using ufo::ReadBuffer::offset_type = BaseBuffer::offset_type

Definition at line 60 of file read_buffer.hpp.

pos_type

using ufo::ReadBuffer::pos_type = BaseBuffer::pos_type

Definition at line 59 of file read_buffer.hpp.

size_type

using ufo::ReadBuffer::size_type = BaseBuffer::size_type

Definition at line 58 of file read_buffer.hpp.

Constructor & Destructor Documentation

ReadBuffer()

ufo::ReadBuffer::ReadBuffer	(	std::byte const *	data,
		size_type	count
	)

Definition at line 51 of file read_buffer.cpp.

Member Function Documentation

read() [1/3]

ReadBuffer & ufo::ReadBuffer::read	(	std::ostream &	out,
		size_type	count
	)

Definition at line 62 of file read_buffer.cpp.

read() [2/3]

template<class T >

ReadBuffer & ufo::ReadBuffer::read ( T &  t )

inline

Definition at line 67 of file read_buffer.hpp.

read() [3/3]

ReadBuffer & ufo::ReadBuffer::read	(	void *	dest,
		size_type	count
	)

Definition at line 55 of file read_buffer.cpp.

readAt() [1/6]

void ufo::ReadBuffer::readAt	(	offset_type	off,
		IODir	dir,
		std::ostream &	out,
		size_type	count
	)		const

Definition at line 95 of file read_buffer.cpp.

readAt() [2/6]

template<class T >

void ufo::ReadBuffer::readAt ( offset_type  off, IODir  dir, T &  t  ) const

inline

Definition at line 87 of file read_buffer.hpp.

readAt() [3/6]

void ufo::ReadBuffer::readAt	(	offset_type	off,
		IODir	dir,
		void *	dest,
		size_type	count
	)		const

Definition at line 90 of file read_buffer.cpp.

readAt() [4/6]

void ufo::ReadBuffer::readAt	(	pos_type	pos,
		std::ostream &	out,
		size_type	count
	)		const

Definition at line 79 of file read_buffer.cpp.

readAt() [5/6]

template<class T >

void ufo::ReadBuffer::readAt ( pos_type  pos, T &  t  ) const

inline

Definition at line 77 of file read_buffer.hpp.

readAt() [6/6]

void ufo::ReadBuffer::readAt	(	pos_type	pos,
		void *	dest,
		size_type	count
	)		const

Definition at line 69 of file read_buffer.cpp.

readLeft()

ReadBuffer::size_type ufo::ReadBuffer::readLeft ( ) const

noexcept

Definition at line 126 of file read_buffer.cpp.

readLine()

bool ufo::ReadBuffer::readLine

(

std::string &

line

)

Definition at line 101 of file read_buffer.cpp.

readPos()

ReadBuffer::pos_type ufo::ReadBuffer::readPos ( ) const

noexcept

Definition at line 113 of file read_buffer.cpp.

readSeek() [1/4]

ReadBuffer & ufo::ReadBuffer::readSeek ( offset_type  off, IODir  dir  )

noexcept

Definition at line 121 of file read_buffer.cpp.

readSeek() [2/4]

ReadBuffer & ufo::ReadBuffer::readSeek ( pos_type  pos )

noexcept

Definition at line 115 of file read_buffer.cpp.

readSeek() [3/4]

template<class T >

ReadBuffer & ufo::ReadBuffer::readSeek ( T const &  t, offset_type  count_signed, IODir  dir  )

inlinenoexcept

Definition at line 111 of file read_buffer.hpp.

readSeek() [4/4]

template<class T >

ReadBuffer & ufo::ReadBuffer::readSeek ( T const &  t, pos_type  count  )

inlinenoexcept

Definition at line 105 of file read_buffer.hpp.

Member Data Documentation

pos_

pos_type ufo::ReadBuffer::pos_ {}

protected

Definition at line 119 of file read_buffer.hpp.

---

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

• lib/io/include/ufo/io/buffer/read_buffer.hpp
• lib/io/src/buffer/read_buffer.cpp