s3d::IReader Class Reference

Reader インタフェース More...

#include <IReader.hpp>

Inherited by s3d::BinaryReader, s3d::MemoryReader, and s3d::MemoryViewReader.

Public Member Functions
virtual	~IReader ()=default
	デストラクタ More...
virtual bool	supportsLookahead () const noexcept=0
	読み込み位置を変更しないデータ読み込みをサポートしているかを返します。 More...
virtual bool	isOpen () const noexcept=0
	Reader が使用可能かを返します。 More...
virtual int64	size () const =0
	Reader のサイズを返します。 More...
virtual int64	getPos () const =0
	Reader の現在の読み込み位置を返します。 More...
virtual bool	setPos (int64 pos)=0
	Reader の読み込み位置を変更します。 More...
virtual int64	skip (int64 offset)=0
	Reader を読み飛ばし、読み込み位置を変更します。 More...
virtual int64	read (void *dst, int64 size)=0
	Reader からデータを読み込みます。 More...
virtual int64	read (void *dst, int64 pos, int64 size)=0
	Reader からデータを読み込みます。 More...
SIV3D_CONCEPT_TRIVIALLY_COPYABLE bool	read (TriviallyCopyable &dst)
	Reader からデータを読み込みます。 More...
virtual int64	lookahead (void *dst, int64 size) const =0
	Reader から読み込み位置を変更しないでデータを読み込みます。 More...
virtual int64	lookahead (void *dst, int64 pos, int64 size) const =0
	Reader から読み込み位置を変更しないでデータを読み込みます。 More...
SIV3D_CONCEPT_TRIVIALLY_COPYABLE bool	lookahead (TriviallyCopyable &dst) const
	読み込み位置を変更しないで Reader からデータを読み込みます。 More...

Detailed Description

Reader インタフェース

Constructor & Destructor Documentation

~IReader()

virtual s3d::IReader::~IReader ( )

virtualdefault

デストラクタ

Member Function Documentation

getPos()

virtual int64 s3d::IReader::getPos ( ) const

pure virtual

Reader の現在の読み込み位置を返します。

Returns

現在の読み込み位置（バイト）

Implemented in s3d::BinaryReader, s3d::MemoryReader, and s3d::MemoryViewReader.

isOpen()

virtual bool s3d::IReader::isOpen ( ) const

pure virtualnoexcept

Reader が使用可能かを返します。

Returns

Reader が使用可能な場合 true, それ以外の場合は false

Implemented in s3d::BinaryReader, s3d::MemoryReader, and s3d::MemoryViewReader.

lookahead() [1/3]

SIV3D_CONCEPT_TRIVIALLY_COPYABLE bool s3d::IReader::lookahead

(

TriviallyCopyable &

dst

)

const

読み込み位置を変更しないで Reader からデータを読み込みます。

Template Parameters

Type

読み込む値の型

Parameters

dst

読み込み先

Returns

読み込みに成功したら true, それ以外の場合は false

lookahead() [2/3]

virtual int64 s3d::IReader::lookahead ( void *  dst, int64  pos, int64  size  ) const

pure virtual

Reader から読み込み位置を変更しないでデータを読み込みます。

Parameters

dst	読み込み先
pos	先頭から数えた読み込み開始位置（バイト）
size	読み込むサイズ（バイト）

Returns

実際に読み込んだサイズ（バイト）

Implemented in s3d::BinaryReader, s3d::MemoryReader, and s3d::MemoryViewReader.

lookahead() [3/3]

virtual int64 s3d::IReader::lookahead ( void *  dst, int64  size  ) const

pure virtual

Reader から読み込み位置を変更しないでデータを読み込みます。

Parameters

dst	読み込み先
size	読み込むサイズ（バイト）

Returns

実際に読み込んだサイズ（バイト）

Implemented in s3d::BinaryReader, s3d::MemoryReader, and s3d::MemoryViewReader.

read() [1/3]

SIV3D_CONCEPT_TRIVIALLY_COPYABLE bool s3d::IReader::read

(

TriviallyCopyable &

dst

)

Reader からデータを読み込みます。

Template Parameters

Type

読み込む値の型

Parameters

dst

読み込み先

Returns

読み込みに成功した場合 true, それ以外の場合は false

read() [2/3]

virtual int64 s3d::IReader::read ( void *  dst, int64  pos, int64  size  )

pure virtual

Reader からデータを読み込みます。

Parameters

dst	読み込み先
pos	先頭から数えた読み込み開始位置（バイト）
size	読み込むサイズ（バイト）

Returns

実際に読み込んだサイズ（バイト）

Implemented in s3d::BinaryReader, s3d::MemoryReader, and s3d::MemoryViewReader.

read() [3/3]

virtual int64 s3d::IReader::read ( void *  dst, int64  size  )

pure virtual

Reader からデータを読み込みます。

Parameters

dst	読み込み先
size	読み込むサイズ（バイト）

Returns

実際に読み込んだサイズ（バイト）

Implemented in s3d::BinaryReader, s3d::MemoryReader, and s3d::MemoryViewReader.

setPos()

virtual bool s3d::IReader::setPos ( int64  pos )

pure virtual

Reader の読み込み位置を変更します。

Parameters

pos	新しい読み込み位置（バイト）

Returns

読み込み位置の変更に成功した場合 true, それ以外の場合は false

Implemented in s3d::BinaryReader, s3d::MemoryReader, and s3d::MemoryViewReader.

size()

virtual int64 s3d::IReader::size ( ) const

pure virtual

Reader のサイズを返します。

Returns

Reader のサイズ（バイト）

Implemented in s3d::BinaryReader, s3d::MemoryReader, and s3d::MemoryViewReader.

skip()

virtual int64 s3d::IReader::skip ( int64  offset )

pure virtual

Reader を読み飛ばし、読み込み位置を変更します。

Parameters

offset

読み飛ばすサイズ（バイト）

Returns

新しい読み込み位置（バイト）

Implemented in s3d::BinaryReader, s3d::MemoryReader, and s3d::MemoryViewReader.

supportsLookahead()

virtual bool s3d::IReader::supportsLookahead ( ) const

pure virtualnoexcept

読み込み位置を変更しないデータ読み込みをサポートしているかを返します。

Returns

読み込み位置を変更しないデータ読み込みをサポートしている場合 true, それ以外の場合は false

Implemented in s3d::BinaryReader, s3d::MemoryReader, and s3d::MemoryViewReader.

---

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

• OpenSiv3D/Siv3D/include/Siv3D/IReader.hpp