MGL ファイルアクセサ [詳解]

#include <mgl/file/mgl_file_access_work.h>
#include <mgl/file/mgl_file_mounter.h>
#include <mgl/file/mgl_file_path_view.h>
#include <mgl/mgl_environment.h>
#include <mgl/stl/mgl_stl_containers.h>

関数
AccessWorkPtr	MGL::File::Accessor::Open (Result &result, const PathView &path, OpenMode mode) noexcept
	ファイルをオープン

Result	MGL::File::Accessor::Close (AccessWorkPtr &work) noexcept
	ファイルをクローズ

size_t	MGL::File::Accessor::Read (AccessWorkPtr &work, Result &result, void *buffer, size_t size) noexcept
	ファイルを読み込み

size_t	MGL::File::Accessor::Write (AccessWorkPtr &work, Result &result, const void *buffer, size_t size) noexcept
	ファイルに書き込み

size_t	MGL::File::Accessor::Seek (AccessWorkPtr &work, Result &result, SeekType seekType, int32_t offset) noexcept
	ストリーム位置を設定

size_t	MGL::File::Accessor::GetOffset (AccessWorkPtr &work, Result &result) noexcept
	ストリーム位置を取得

bool	MGL::File::Accessor::IsEOF (AccessWorkPtr &work, Result &result) noexcept
	ファイルストリームが終端に達しているかを取得

size_t	MGL::File::Accessor::GetSize (AccessWorkPtr &work, Result &result) noexcept
	オープンしているファイルのサイズを取得

size_t	MGL::File::Accessor::GetSize (Result &result, const PathView &path) noexcept
	ファイルのサイズを取得

Result	MGL::File::Accessor::MakeDirectory (const PathView &path) noexcept
	ディレクトリを作成する

Result	MGL::File::Accessor::Move (const PathView &sourcePath, const PathView &destPath) noexcept
	ファイルの移動・リネーム

Result	MGL::File::Accessor::Remove (const PathView &path) noexcept
	ファイルの削除

Result	MGL::File::Accessor::Copy (const PathView &sourcePath, const PathView &destPath) noexcept
	ファイルのコピー

bool	MGL::File::Accessor::Exists (Result &result, const PathView &path) noexcept
	ファイルの存在をチェック

bool	MGL::File::Accessor::IsSystemNativeFile (Result &result, const PathView &path) noexcept
	パスがシステム標準のファイルかを取得

Result	MGL::File::Accessor::Mount (const PathView &mountName, const PathView &path, MountAccessType accessType, DelegateKey delegateKey) noexcept
	マウント

Result	MGL::File::Accessor::Unmount (const PathView &mountName) noexcept
	マウント解除

Result	MGL::File::Accessor::Remount (const PathView &mountName, const PathView &path, MountAccessType accessType, DelegateKey delegateKey) noexcept
	再マウント

bool	MGL::File::Accessor::IsMounted (const PathView &mountName) noexcept
	マウントされているかを取得

STL::string	MGL::File::Accessor::GetSystemNativePath (Result &result, const PathView &path) noexcept
	マウントパスからシステム標準のパスに変換

template<class DelegateClass , class... Args>
constexpr Result	MGL::File::Accessor::AddDelegate (DelegateKey key, Args... args) noexcept
	デリゲートの追加

Result	MGL::File::Accessor::RemoveDelegate (DelegateKey key) noexcept
	デリゲートの削除

void	MGL::File::Accessor::SetDefaultDelegate (DelegateKey key) noexcept
	デフォルトのデリゲートを設定

詳解

MGL ファイルアクセサ

日付: Since: January 20, 2021. 11:21:53 JST.

著者: Acerola

関数詳解

◆ AddDelegate()

template<class DelegateClass , class... Args>

Result MGL::File::Accessor::AddDelegate	(	DelegateKey	key,
		Args...	args )

constexprnoexcept

デリゲートの追加

テンプレート引数

DelegateClass 追加するデリゲートクラス

引数

[in]	key	デリゲートキー
[in]	args	デリゲートクラスのコンストラクタに渡す引数

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

◆ Close()

Result MGL::File::Accessor::Close ( AccessWorkPtr & work )

noexcept

ファイルをクローズ

引数

[in,out] work ファイルアクセス用のワーク

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

◆ Copy()

Result MGL::File::Accessor::Copy	(	const PathView &	sourcePath,
		const PathView &	destPath )

noexcept

ファイルのコピー

引数

[in]	sourcePath	コピー元のパス
[in]	destPath	コピー先のパス

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

◆ Exists()

bool MGL::File::Accessor::Exists	(	Result &	result,
		const PathView &	path )

noexcept

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

引数

[out]	result	処理結果
[in]	path	チェックするファイルのパス

戻り値

true	存在する
false	存在しない

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

◆ GetOffset()

size_t MGL::File::Accessor::GetOffset	(	AccessWorkPtr &	work,
		Result &	result )

noexcept

ストリーム位置を取得

引数

[in,out]	work	アクセスするファイルのワーク
[out]	result	処理結果

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

◆ GetSize() [1/2]

size_t MGL::File::Accessor::GetSize	(	AccessWorkPtr &	work,
		Result &	result )

noexcept

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

引数

[in,out]	work	アクセスするファイルのワーク
[out]	result	処理結果

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

◆ GetSize() [2/2]

size_t MGL::File::Accessor::GetSize	(	Result &	result,
		const PathView &	path )

noexcept

ファイルのサイズを取得

引数

[out]	result	処理結果
[in]	path	サイズを取得するファイルのパス

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

◆ GetSystemNativePath()

STL::string MGL::File::Accessor::GetSystemNativePath	(	Result &	result,
		const PathView &	path )

noexcept

マウントパスからシステム標準のパスに変換

引数

[out]	result	処理結果
[in]	path	パス

戻り値: システム標準のパス

◆ IsEOF()

bool MGL::File::Accessor::IsEOF	(	AccessWorkPtr &	work,
		Result &	result )

noexcept

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

引数

[in,out]	work	アクセスするファイルのワーク
[out]	result	処理結果

戻り値

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

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

◆ IsMounted()

bool MGL::File::Accessor::IsMounted ( const PathView & mountName )

inlinenodiscardnoexcept

マウントされているかを取得

引数

[in] mountName マウント名

戻り値

true	マウントされている
false	マウントされていない

◆ IsSystemNativeFile()

bool MGL::File::Accessor::IsSystemNativeFile	(	Result &	result,
		const PathView &	path )

noexcept

パスがシステム標準のファイルかを取得

引数

[out]	result	処理結果
[in]	path	パス

戻り値

true	システム標準のファイルである
false	システム標準のファイルではない

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

◆ MakeDirectory()

Result MGL::File::Accessor::MakeDirectory ( const PathView & path )

noexcept

ディレクトリを作成する

引数

[in] path 作成するディレクトリのパス

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

◆ Mount()

Result MGL::File::Accessor::Mount	(	const PathView &	mountName,
		const PathView &	path,
		MountAccessType	accessType,
		DelegateKey	delegateKey )

noexcept

マウント

引数

[in]	mountName	マウント名
[in]	path	マウント先のパス
[in]	accessType	アクセスタイプ
[in]	delegateKey	デリゲートキー

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

◆ Move()

Result MGL::File::Accessor::Move	(	const PathView &	sourcePath,
		const PathView &	destPath )

noexcept

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

引数

[in]	sourcePath	移動元のパス
[in]	destPath	移動先のパス

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

◆ Open()

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

noexcept

ファイルをオープン

引数

[out]	result	処理結果
[in]	path	オープンするファイルのパス
[in]	mode	オープンモード

戻り値: オープンしたファイルのワーク．失敗時にはnullptrが返り，resultにエラーが設定される

◆ Read()

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

noexcept

ファイルを読み込み

引数

[in,out]	work	ファイルアクセス用のワーク
[out]	result	処理結果
[out]	buffer	読み込み先のバッファ
[in]	size	読み込むサイズ

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

◆ Remount()

Result MGL::File::Accessor::Remount	(	const PathView &	mountName,
		const PathView &	path,
		MountAccessType	accessType,
		DelegateKey	delegateKey )

noexcept

再マウント

引数

[in]	mountName	マウント名
[in]	path	マウント先のパス
[in]	accessType	アクセスタイプ
[in]	delegateKey	デリゲートキー

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

◆ Remove()

Result MGL::File::Accessor::Remove ( const PathView & path )

noexcept

ファイルの削除

引数

[in] path 削除するファイルのパス

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

◆ RemoveDelegate()

Result MGL::File::Accessor::RemoveDelegate ( DelegateKey key )

inlinenoexcept

デリゲートの削除

引数

[in] key 削除するデリゲートキー

戻り値: 失敗時にはいずれかのエラーが設定される．存在しないデリゲートキーに対しては何もしない

◆ Seek()

size_t MGL::File::Accessor::Seek	(	AccessWorkPtr &	work,
		Result &	result,
		SeekType	seekType,
		int32_t	offset )

noexcept

ストリーム位置を設定

引数

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

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

◆ SetDefaultDelegate()

void MGL::File::Accessor::SetDefaultDelegate ( DelegateKey key )

inlinenoexcept

デフォルトのデリゲートを設定

引数

[in] key デフォルトのデリゲートキー

◆ Unmount()

Result MGL::File::Accessor::Unmount ( const PathView & mountName )

noexcept

マウント解除

引数

[in] mountName マウント名

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

◆ Write()

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

noexcept

ファイルに書き込み

引数

[in,out]	work	ファイルアクセス用のワーク
[out]	result	処理結果
[out]	buffer	書き込むデータを格納したバッファ
[in]	size	書き込むサイズ

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