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

#include <mgl_file_delegate.h>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

詳解

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

関数詳解

◆ Close()

virtual Result MGL::File::Delegate::Close ( AccessWork * work )

pure virtualnoexcept

ファイルをクローズ

引数

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

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

MGL::File::Win32Delegateで実装されています。

◆ Exists()

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

pure virtualnoexcept

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

引数

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

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

MGL::File::Win32Delegateで実装されています。

◆ GetOffset()

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

pure virtualnoexcept

ストリーム位置を取得

引数

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

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

MGL::File::Win32Delegateで実装されています。

◆ GetSize() [1/2]

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

pure virtualnoexcept

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

引数

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

戻り値: ファイルサイズ

MGL::File::Win32Delegateで実装されています。

◆ GetSize() [2/2]

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

pure virtualnoexcept

ファイルのサイズを取得

引数

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

戻り値: ファイルサイズ

MGL::File::Win32Delegateで実装されています。

◆ IsEOF()

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

pure virtualnoexcept

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

引数

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

戻り値

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

MGL::File::Win32Delegateで実装されています。

◆ IsManagedSystemNativeFile()

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

nodiscardpure virtualnoexcept

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

戻り値

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

MGL::File::Win32Delegateで実装されています。

◆ IsWritable()

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

nodiscardpure virtualnoexcept

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

戻り値

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

MGL::File::Win32Delegateで実装されています。

◆ MakeDirectory()

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

pure virtualnoexcept

ディレクトリを作成する

引数

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

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

MGL::File::Win32Delegateで実装されています。

◆ Mount()

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

pure virtualnoexcept

マウント時の処理

引数

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

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

MGL::File::Win32Delegateで実装されています。

◆ Move()

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

pure virtualnoexcept

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

引数

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

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

MGL::File::Win32Delegateで実装されています。

◆ Open()

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

pure virtualnoexcept

ファイルをオープン

引数

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

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

MGL::File::Win32Delegateで実装されています。

◆ Read()

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

pure virtualnoexcept

ファイルを読み込み

引数

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

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

MGL::File::Win32Delegateで実装されています。

◆ Remove()

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

pure virtualnoexcept

ファイルの削除

引数

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

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

MGL::File::Win32Delegateで実装されています。

◆ Seek()

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

pure virtualnoexcept

ストリーム位置を設定

引数

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

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

MGL::File::Win32Delegateで実装されています。

◆ Unmount()

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

pure virtualnoexcept

マウント解除時の処理

引数

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

MGL::File::Win32Delegateで実装されています。

◆ Write()

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

pure virtualnoexcept

ファイルを書き込み

引数

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

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

MGL::File::Win32Delegateで実装されています。

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

/Users/acerola/x/mgl/include/mgl/file/mgl_file_delegate.h

公開メンバ関数

詳解

関数詳解

◆ Close()

◆ Exists()

◆ GetOffset()

◆ GetSize() [1/2]

◆ GetSize() [2/2]

◆ IsEOF()

◆ IsManagedSystemNativeFile()

◆ IsWritable()

◆ MakeDirectory()

◆ Mount()

◆ Move()

◆ Open()

◆ Read()

◆ Remove()

◆ Seek()

◆ Unmount()

◆ Write()