Win32用ファイルデリゲートクラス [詳解]

#include <mgl_file_delegate_win32.h>

MGL::File::Win32Delegate の継承関係図

クラス
struct	Win32Work
	このデリゲート用の作業用構造体 [詳解]

公開メンバ関数
virtual bool	IsManagedSystemNativeFile () const noexcept override
	このデリゲートがシステム標準のファイルを扱うものかを取得

virtual bool	IsWritable () const noexcept override
	このデリゲートが書き込みに対応しているかを取得

virtual Result	Mount (SharedMountWork &mountWork, const PathView &path, MountAccessType accessType) noexcept override
	マウント時の処理

virtual void	Unmount (SharedMountWork &mountWork) noexcept override
	マウント解除時の処理

virtual AccessWorkPtr	Open (Result &result, SharedMountWork &mountWork, const PathView &path, OpenMode mode) noexcept override
	ファイルをオープン

virtual Result	Close (AccessWork *work) noexcept override
	ファイルをクローズ

virtual size_t	Read (AccessWork work, Result &result, void buffer, size_t size) noexcept override
	ファイルを読み込み

virtual size_t	Write (AccessWork work, Result &result, const void buffer, size_t size) noexcept override
	ファイルを書き込み

virtual size_t	Seek (AccessWork *work, Result &result, SeekType seekType, int32_t offset) noexcept override
	ストリーム位置を設定

virtual size_t	GetOffset (AccessWork *work, Result &result) const noexcept override
	ストリーム位置を取得

virtual bool	IsEOF (AccessWork *work, Result &result) const noexcept override
	ファイルストリームが終端に達しているかを取得

virtual size_t	GetSize (AccessWork *work, Result &result) const noexcept override
	オープンしているファイルのサイズを取得

virtual size_t	GetSize (MountWork *mountWork, Result &result, const PathView &path) const noexcept override
	ファイルのサイズを取得

virtual Result	MakeDirectory (MountWork *mountWork, const PathView &path) noexcept override
	ディレクトリを作成する

virtual Result	Move (MountWork *mountWork, const PathView &sourcePath, const PathView &destPath) noexcept override
	ファイルの移動・リネーム

virtual Result	Remove (MountWork *mountWork, const PathView &path) noexcept override
	ファイルの削除

virtual bool	Exists (MountWork *mountWork, Result &result, const PathView &path) noexcept override
	ファイルの存在をチェック

基底クラス MGL::File::Delegate に属する継承公開メンバ関数

静的公開変数類
static constexpr DelegateKey	kDelegateKey = MakeDelegateKey("MGL-Win32")
	このデリゲートを表すデリゲートキー

詳解

Win32用ファイルデリゲートクラス

関数詳解

◆ Close()

Result MGL::File::Win32Delegate::Close ( AccessWork * work )

overridevirtualnoexcept

ファイルをクローズ

引数

[in,out] work クローズするファイルのワーク

戻り値: エラー発生時にいずれかのエラーが設定される

MGL::File::Delegateを実装しています。

◆ Exists()

bool MGL::File::Win32Delegate::Exists	(	MountWork *	mountWork,
		Result &	result,
		const PathView &	path )

overridevirtualnoexcept

ファイルの存在をチェック

引数

[in,out]	mountWork	マウント毎のワーク
[out]	result	エラー発生時の結果の格納先
[in]	path	チェックするファイルのパス

戻り値: 存在する場合はエラーなしのリザルトが返る

MGL::File::Delegateを実装しています。

◆ GetOffset()

size_t MGL::File::Win32Delegate::GetOffset	(	AccessWork *	work,
		Result &	result ) const

overridevirtualnoexcept

ストリーム位置を取得

引数

[in]	work	アクセスするファイルのワーク
[out]	result	エラー発生時の結果の格納先

戻り値: 現在のストリーム位置

MGL::File::Delegateを実装しています。

◆ GetSize() [1/2]

size_t MGL::File::Win32Delegate::GetSize	(	AccessWork *	work,
		Result &	result ) const

overridevirtualnoexcept

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

引数

[in]	work	アクセスするファイルのワーク
[out]	result	エラー発生時の結果の格納先

戻り値: ファイルサイズ

MGL::File::Delegateを実装しています。

◆ GetSize() [2/2]

size_t MGL::File::Win32Delegate::GetSize	(	MountWork *	mountWork,
		Result &	result,
		const PathView &	path ) const

overridevirtualnoexcept

ファイルのサイズを取得

引数

[in,out]	mountWork	マウント毎のワーク
[out]	result	エラー発生時の結果の格納先
[in]	path	サイズを取得するファイルのパス

戻り値: ファイルサイズ

MGL::File::Delegateを実装しています。

◆ IsEOF()

bool MGL::File::Win32Delegate::IsEOF	(	AccessWork *	work,
		Result &	result ) const

overridevirtualnoexcept

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

引数

[in,out]	work	アクセスするファイルのワーク
[out]	result	エラー発生時の結果の格納先

戻り値

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

MGL::File::Delegateを実装しています。

◆ IsManagedSystemNativeFile()

virtual bool MGL::File::Win32Delegate::IsManagedSystemNativeFile ( ) const

inlineoverridevirtualnoexcept

このデリゲートがシステム標準のファイルを扱うものかを取得

戻り値

true	システム標準のファイルを扱う
false	システム標準ではないファイルを扱う

MGL::File::Delegateを実装しています。

◆ IsWritable()

virtual bool MGL::File::Win32Delegate::IsWritable ( ) const

inlineoverridevirtualnoexcept

このデリゲートが書き込みに対応しているかを取得

戻り値

true	対応している
false	対応していない

MGL::File::Delegateを実装しています。

◆ MakeDirectory()

Result MGL::File::Win32Delegate::MakeDirectory	(	MountWork *	mountWork,
		const PathView &	path )

overridevirtualnoexcept

ディレクトリを作成する

引数

[in,out]	mountWork	マウント毎のワーク
[in]	path	作成するディレクトリのパス

戻り値: エラー発生時にはいずれかのエラーが設定される

MGL::File::Delegateを実装しています。

◆ Mount()

virtual Result MGL::File::Win32Delegate::Mount	(	SharedMountWork &	mountWork,
		const PathView &	path,
		MountAccessType	accessType )

inlineoverridevirtualnoexcept

マウント時の処理

引数

[out]	mountWork	マウント毎に使用するワークの共有ポインタ
[in]	path	マウントパス
[in]	accessType	アクセスタイプ

戻り値: エラー発生時にいずれかのエラーが設定される

MGL::File::Delegateを実装しています。

◆ Move()

Result MGL::File::Win32Delegate::Move	(	MountWork *	mountWork,
		const PathView &	sourcePath,
		const PathView &	destPath )

overridevirtualnoexcept

ファイルの移動・リネーム

引数

[in,out]	mountWork	マウント毎のワーク
[in]	sourcePath	移動元のパス
[in]	destPath	移動先のパス

戻り値: エラー発生時にはいずれかのエラーが設定される

MGL::File::Delegateを実装しています。

◆ Open()

AccessWorkPtr MGL::File::Win32Delegate::Open	(	Result &	result,
		SharedMountWork &	mountWork,
		const PathView &	path,
		OpenMode	mode )

overridevirtualnoexcept

ファイルをオープン

引数

[out]	result	処理結果
[in,out]	mountWork	マウント毎のワーク
[in]	path	オープンするファイルのパス
[in]	mode	オープンモード

戻り値: オープンしたファイルのワーク

MGL::File::Delegateを実装しています。

◆ Read()

size_t MGL::File::Win32Delegate::Read	(	AccessWork *	work,
		Result &	result,
		void *	buffer,
		size_t	size )

overridevirtualnoexcept

ファイルを読み込み

引数

[in,out]	work	アクセスするファイルのワーク
[out]	result	処理結果
[in]	buffer	読み込み先のアドレス
[in]	size	読み込みサイズ

戻り値: 実際に読み込んだバイト数

MGL::File::Delegateを実装しています。

◆ Remove()

Result MGL::File::Win32Delegate::Remove	(	MountWork *	mountWork,
		const PathView &	path )

overridevirtualnoexcept

ファイルの削除

引数

[in,out]	mountWork	マウント毎のワーク
[in]	path	削除するファイルのパス

戻り値: エラー発生時にはいずれかのエラーが設定される

MGL::File::Delegateを実装しています。

◆ Seek()

size_t MGL::File::Win32Delegate::Seek	(	AccessWork *	work,
		Result &	result,
		SeekType	seekType,
		int32_t	offset )

overridevirtualnoexcept

ストリーム位置を設定

引数

[in,out]	work	アクセスするファイルのワーク
[out]	result	処理結果
[in]	seekType	シークタイプ
[in]	offset	オフセット

戻り値: エラー発生時にはいずれかのエラーが設定される

MGL::File::Delegateを実装しています。

◆ Unmount()

virtual void MGL::File::Win32Delegate::Unmount ( SharedMountWork & mountWork )

inlineoverridevirtualnoexcept

マウント解除時の処理

引数

[out] mountWork マウント毎に使用するワークの共有ポインタ

MGL::File::Delegateを実装しています。

◆ Write()

size_t MGL::File::Win32Delegate::Write	(	AccessWork *	work,
		Result &	result,
		const void *	buffer,
		size_t	size )

overridevirtualnoexcept

ファイルを書き込み

引数

[in,out]	work	アクセスするファイルのワーク
[out]	result	処理結果
[out]	buffer	書き込み先のアドレス
[in]	size	書き込みサイズ

戻り値: 実際に書き込んだバイト数

MGL::File::Delegateを実装しています。

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

/Users/acerola/work/mgl-work/mgl/include/mgl/file/delegate/mgl_file_delegate_win32.h
/Users/acerola/work/mgl-work/mgl/src/file/delegate/mgl_file_delegate_win32.cc

クラス

公開メンバ関数

静的公開変数類

詳解

関数詳解

◆ Close()

◆ Exists()

◆ GetOffset()

◆ GetSize() [1/2]

◆ GetSize() [2/2]

◆ IsEOF()

◆ IsManagedSystemNativeFile()

◆ IsWritable()

◆ MakeDirectory()

◆ Mount()

◆ Move()

◆ Open()

◆ Read()

◆ Remove()

◆ Seek()

◆ Unmount()

◆ Write()