MGL::File::ThrowingHandle クラス

例外を発生させるファイルハンドルクラス [詳解]

#include <mgl_file_throwing_handle.h>

公開メンバ関数
constexpr	ThrowingHandle () noexcept
	コンストラクタ
	ThrowingHandle (const PathView &path, OpenMode mode=OpenMode::Read)
	コンストラクタ
void	Open (const PathView &path, OpenMode mode=OpenMode::Read)
	ファイルをオープン
void	Close ()
	ファイルをクローズ
constexpr bool	IsOpen () const noexcept
	ファイルがオープンされているかを取得
size_t	Read (void *buffer, size_t size)
	ファイルの読み込み
size_t	Write (const void *buffer, size_t size)
	ファイルに書き込み
size_t	Seek (SeekType seekType, int32_t offset)
	ストリーム位置を設定
size_t	Seek (SeekType seekType, size_t offset)
	ストリーム位置を設定
size_t	Skip (size_t size)
	ストリーム位置をスキップ
size_t	GetOffset ()
	ストリーム位置を取得
bool	IsEOF ()
	ファイルストリームが終端に達しているかを取得
size_t	GetSize ()
	オープンしているファイルのサイズを取得
	ThrowingHandle (const ThrowingHandle &)=delete
ThrowingHandle &	operator= (const ThrowingHandle &)=delete
	ThrowingHandle (ThrowingHandle &&other) noexcept
	ムーブコンストラクタ
ThrowingHandle &	operator= (ThrowingHandle &&other) noexcept
	ムーブ代入演算

詳解

例外を発生させるファイルハンドルクラス

構築子と解体子

ThrowingHandle() [1/2]

MGL::File::ThrowingHandle::ThrowingHandle	(	const PathView &	path,
		OpenMode	mode = OpenMode::Read )

コンストラクタ

引数

[in]	path	オープンするファイルのパス
[in]	mode	オープンモード

例外

MGL::File::Result

失敗時にエラーが設定されたリザルトを返す

ThrowingHandle() [2/2]

MGL::File::ThrowingHandle::ThrowingHandle ( ThrowingHandle && other )

inlinenoexcept

ムーブコンストラクタ

引数

[in]

other

移動元ハンドル

関数詳解

Close()

void MGL::File::ThrowingHandle::Close

(

)

ファイルをクローズ

例外

MGL::File::Result

失敗時にエラーが設定されたリザルトを返す

GetOffset()

size_t MGL::File::ThrowingHandle::GetOffset ( )

nodiscard

ストリーム位置を取得

戻り値

現在のストリーム位置

例外

MGL::File::Result

失敗時にエラーが設定されたリザルトを返す

GetSize()

size_t MGL::File::ThrowingHandle::GetSize ( )

nodiscard

オープンしているファイルのサイズを取得

戻り値

ファイルサイズ

例外

MGL::File::Result

失敗時にエラーが設定されたリザルトを返す

IsEOF()

bool MGL::File::ThrowingHandle::IsEOF ( )

nodiscard

ファイルストリームが終端に達しているかを取得

戻り値

true	終端に達している
false	終端に達していない

例外

MGL::File::Result

失敗時にエラーが設定されたリザルトを返す

IsOpen()

bool MGL::File::ThrowingHandle::IsOpen ( ) const

inlinenodiscardconstexprnoexcept

ファイルがオープンされているかを取得

戻り値

true	オープンされている
false	オープンされていない

Open()

void MGL::File::ThrowingHandle::Open	(	const PathView &	path,
		OpenMode	mode = OpenMode::Read )

ファイルをオープン

引数

[in]	path	オープンするファイルのパス
[in]	mode	オープンモード

例外

MGL::File::Result

失敗時にエラーが設定されたリザルトを返す

operator=()

ThrowingHandle & MGL::File::ThrowingHandle::operator= ( ThrowingHandle && other )

inlinenoexcept

ムーブ代入演算

引数

[in]

other

移動元ハンドル

Read()

size_t MGL::File::ThrowingHandle::Read	(	void *	buffer,
		size_t	size )

ファイルの読み込み

引数

[out]	buffer	読み込み先のバッファ
[in]	size	読み込むサイズ

戻り値

実際に読み込んだサイズ

例外

MGL::File::Result

失敗時にエラーが設定されたリザルトを返す

Seek() [1/2]

size_t MGL::File::ThrowingHandle::Seek	(	SeekType	seekType,
		int32_t	offset )

ストリーム位置を設定

引数

[in]	seekType	シークタイプ
[in]	offset	オフセット

戻り値

設定後のストリーム位置

例外

MGL::File::Result

失敗時にエラーが設定されたリザルトを返す

Seek() [2/2]

size_t MGL::File::ThrowingHandle::Seek	(	SeekType	seekType,
		size_t	offset )

ストリーム位置を設定

引数

[in]	seekType	シークタイプ
[in]	offset	オフセット

戻り値

設定後のストリーム位置

例外

MGL::File::Result

失敗時にエラーが設定されたリザルトを返す

Skip()

size_t MGL::File::ThrowingHandle::Skip

(

size_t

size

)

ストリーム位置をスキップ

引数

[in]

size

スキップするサイズ

戻り値

スキップ後のストリーム位置

例外

MGL::File::Result

失敗時にエラーが設定されたリザルトを返す

Write()

size_t MGL::File::ThrowingHandle::Write	(	const void *	buffer,
		size_t	size )

ファイルに書き込み

引数

[out]	buffer	書き込むデータを格納したバッファ
[in]	size	書き込むサイズ

戻り値

実際に書き込んだサイズ

例外

MGL::File::Result

失敗時にエラーが設定されたリザルトを返す

---

このクラス詳解は次のファイルから抽出されました:

• /Users/acerola/work/mgl-work/mgl/include/mgl/file/mgl_file_throwing_handle.h
• /Users/acerola/work/mgl-work/mgl/src/file/mgl_file_throwing_handle.cc