MGL::File::Handle クラス

ファイルハンドルクラス [詳解]

#include <mgl_file_handle.h>

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

詳解

ファイルハンドルクラス

構築子と解体子

Handle() [1/2]

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

noexcept

コンストラクタ

引数

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

Handle() [2/2]

MGL::File::Handle::Handle ( Handle && other )

inlinenoexcept

ムーブコンストラクタ

引数

[in]

other

移動元ハンドル

関数詳解

Close()

Result MGL::File::Handle::Close ( )

noexcept

ファイルをクローズ

戻り値

処理結果

GetOffset()

size_t MGL::File::Handle::GetOffset ( )

nodiscardnoexcept

ストリーム位置を取得

戻り値

現在のストリーム位置．失敗時にはいずれかのエラーが設定される

GetResult()

const Result & MGL::File::Handle::GetResult ( ) const

inlinenodiscardconstexprnoexcept

処理結果の取得

戻り値

最後に実行した処理の処理結果

GetSize()

size_t MGL::File::Handle::GetSize ( )

nodiscardnoexcept

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

戻り値

ファイルサイズ．失敗時にはいずれかのエラーが設定される

HasError()

bool MGL::File::Handle::HasError ( ) const

inlinenodiscardconstexprnoexcept

最後の処理でエラーが発生しているかの取得

戻り値

true	エラーが発生している
false	エラーは発生していない

IsEOF()

bool MGL::File::Handle::IsEOF ( )

nodiscardnoexcept

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

戻り値

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

覚え書き

失敗時には戻り値にいずれかのエラーが設定される

IsOpen()

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

inlinenodiscardconstexprnoexcept

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

戻り値

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

Open()

Result MGL::File::Handle::Open ( const PathView & path, OpenMode mode = OpenMode::Read )

noexcept

ファイルをオープン

引数

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

戻り値

処理結果

operator=()

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

inlinenoexcept

ムーブ代入演算

引数

[in]

other

移動元ハンドル

Read()

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

noexcept

ファイルの読み込み

引数

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

戻り値

実際に読み込んだサイズ．失敗時はいずれかのエラーが設定される

Seek() [1/2]

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

noexcept

ストリーム位置を設定

引数

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

戻り値

設定後のストリーム位置．失敗時にはいずれかのエラーが設定される

Seek() [2/2]

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

noexcept

ストリーム位置を設定

引数

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

戻り値

設定後のストリーム位置．失敗時にはいずれかのエラーが設定される

Skip()

size_t MGL::File::Handle::Skip ( size_t size )

noexcept

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

引数

[in]

size

スキップするサイズ

戻り値

スキップ後のストリーム位置．失敗時にはいずれかのエラーが設定される

Write()

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

noexcept

ファイルに書き込み

引数

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

戻り値

実際に書き込んだサイズ．失敗時はいずれかのエラーが設定される

---

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

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