例外を発生させるファイルユーティリティクラス [詳解]

#include <mgl_file_throwing_utility.h>

公開メンバ関数
size_t	GetSize (const PathView &path)
	ファイルのサイズを取得

void	MakeDirectory (const PathView &path)
	ディレクトリを作成する

void	Move (const PathView &sourcePath, const PathView &destPath)
	ファイルの移動・リネーム

void	Remove (const PathView &path)
	ファイルの削除

void	Copy (const PathView &sourcePath, const PathView &destPath)
	ファイルのコピー

bool	Exists (const PathView &path)
	ファイルの存在をチェック

bool	IsSystemNativeFile (const PathView &path)
	システム標準のファイルであるかをチェック

void	Mount (const PathView &mountName, const PathView &path, MountAccessType accessType, DelegateKey delegateKey=Mounter::kDefaultDelegateKey)
	マウント

void	Unmount (const PathView &mountName)
	マウント解除

void	Remount (const PathView &mountName, const PathView &path, MountAccessType accessType, DelegateKey delegateKey=Mounter::kDefaultDelegateKey)
	再マウント

STL::string	GetSystemNativePath (const PathView &path)
	マウントパスからシステム標準のパスに変換

void	RemoveDelegate (DelegateKey key)
	デリゲートの削除

template<class DelegateClass , class... Args>
constexpr void	AddDelegate (DelegateKey key, Args... args)
	デリゲートの追加

静的公開メンバ関数
static bool	IsMounted (const PathView &mountName) noexcept
	マウントされているかを取得

static void	SetDefaultDelegate (DelegateKey key) noexcept
	デフォルトのデリゲートを設定

詳解

例外を発生させるファイルユーティリティクラス

関数詳解

◆ AddDelegate()

template<class DelegateClass , class... Args>

void MGL::File::ThrowingUtility::AddDelegate	(	DelegateKey	key,
		Args...	args )

inlineconstexpr

デリゲートの追加

テンプレート引数

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

引数

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

例外

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

◆ Copy()

void MGL::File::ThrowingUtility::Copy	(	const PathView &	sourcePath,
		const PathView &	destPath )

ファイルのコピー

引数

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

例外

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

◆ Exists()

bool MGL::File::ThrowingUtility::Exists ( const PathView & path )

nodiscard

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

引数

[in] path チェックするファイルのパス

戻り値

true	存在する
false	存在しない

例外

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

◆ GetSize()

size_t MGL::File::ThrowingUtility::GetSize ( const PathView & path )

nodiscard

ファイルのサイズを取得

引数

[in] path サイズを取得するファイルのパス

戻り値: ファイルサイズ

例外

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

◆ GetSystemNativePath()

STL::string MGL::File::ThrowingUtility::GetSystemNativePath ( const PathView & path )

nodiscard

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

引数

[in] path パス

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

例外

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

◆ IsMounted()

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

staticnodiscardnoexcept

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

引数

[in] mountName マウント名

戻り値

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

覚え書き: この関数は例外を発生させず，File::IsMounted()と等価である

◆ IsSystemNativeFile()

bool MGL::File::ThrowingUtility::IsSystemNativeFile ( const PathView & path )

nodiscard

システム標準のファイルであるかをチェック

引数

[in] path パス

戻り値

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

例外

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

◆ MakeDirectory()

void MGL::File::ThrowingUtility::MakeDirectory ( const PathView & path )

ディレクトリを作成する

引数

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

例外

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

◆ Mount()

void MGL::File::ThrowingUtility::Mount	(	const PathView &	mountName,
		const PathView &	path,
		MountAccessType	accessType,
		DelegateKey	delegateKey = Mounter::kDefaultDelegateKey )

マウント

引数

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

例外

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

◆ Move()

void MGL::File::ThrowingUtility::Move	(	const PathView &	sourcePath,
		const PathView &	destPath )

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

引数

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

例外

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

◆ Remount()

void MGL::File::ThrowingUtility::Remount	(	const PathView &	mountName,
		const PathView &	path,
		MountAccessType	accessType,
		DelegateKey	delegateKey = Mounter::kDefaultDelegateKey )

再マウント

引数

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

例外

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

◆ Remove()

void MGL::File::ThrowingUtility::Remove ( const PathView & path )

ファイルの削除

引数

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

例外

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

◆ RemoveDelegate()

void MGL::File::ThrowingUtility::RemoveDelegate ( DelegateKey key )

デリゲートの削除

引数

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

例外

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

覚え書き: 存在しないデリゲートキーに対しては何もしない

◆ SetDefaultDelegate()

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

staticnoexcept

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

引数

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

覚え書き: この関数は例外を発生させず，File::SetDefaultDelegate()と等価である

◆ Unmount()

void MGL::File::ThrowingUtility::Unmount ( const PathView & mountName )

マウント解除

引数

[in] mountName マウント名

例外

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

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

/Users/acerola/x/mgl/include/mgl/file/mgl_file_throwing_utility.h
/Users/acerola/x/mgl/src/file/mgl_file_throwing_utility.cc

公開メンバ関数

静的公開メンバ関数

詳解

関数詳解

◆ AddDelegate()

◆ Copy()

◆ Exists()

◆ GetSize()

◆ GetSystemNativePath()

◆ IsMounted()

◆ IsSystemNativeFile()

◆ MakeDirectory()

◆ Mount()

◆ Move()

◆ Remount()

◆ Remove()

◆ RemoveDelegate()

◆ SetDefaultDelegate()

◆ Unmount()