MGL::File::Mounter クラス

ファイルマウンタ [詳解]

#include <mgl_file_mounter.h>

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

クラス
struct	MountProperty
	マウント情報 [詳解]

公開型
using	SharedMountProperty = std::shared_ptr<MountProperty>
	マウント情報の共有ポインタ

公開メンバ関数
Result	Mount (const PathView &mountName, const PathView &path, MountAccessType accessType, DelegateKey delegateKey=kDefaultDelegateKey) noexcept
	マウント
Result	Unmount (const PathView &mountName) noexcept
	マウント解除
SharedMountProperty	Get (const PathView &mountName) noexcept
	マウント情報を取得
bool	IsMounted (const PathView &mountName) noexcept
	マウントされているかを取得
Result	AddDelegate (DelegateKey key, const SharedDelegate &delegate) noexcept
	デリゲートを追加
Result	RemoveDelegate (DelegateKey key) noexcept
	デリゲートを削除
SharedDelegate	GetDelegate (DelegateKey key=kDefaultDelegateKey) noexcept
	デリゲートを取得
void	SetDefaultDelegate (DelegateKey key) noexcept
	デフォルトのデリゲートを設定
基底クラス MGL::SharedSingleton< Mounter > に属する継承公開メンバ関数
	SharedSingleton (const SharedSingleton &) noexcept=delete
	SharedSingleton (SharedSingleton &&) noexcept=delete
SharedSingleton &	operator= (const SharedSingleton &) noexcept=delete
SharedSingleton &	operator= (SharedSingleton &&) noexcept=delete

静的公開メンバ関数
static STL::unique_ptr< Mounter > &	GetInstanceRef () noexcept
	インスタンスの取得
基底クラス MGL::SharedSingleton< Mounter > に属する継承静的公開メンバ関数
static Mounter &	CreateInstance (Args... args) noexcept
	インスタンスの生成
static Mounter &	GetInstance () noexcept
	インスタンスの取得
static void	DestroyInstance () noexcept
	インスタンスの破棄
static bool	HasInstance () noexcept
	有効なインスタンスを保持しているかを取得

静的公開変数類
static constexpr DelegateKey	kDefaultDelegateKey = MakeDelegateKey("MGL-Default")
	デフォルトを表す予約デリゲートキー

詳解

ファイルマウンタ

関数詳解

AddDelegate()

Result MGL::File::Mounter::AddDelegate ( DelegateKey key, const SharedDelegate & delegate )

noexcept

デリゲートを追加

引数

[in]	key	デリゲートキー
[in]	delegate	追加するデリゲート

戻り値

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

Get()

Mounter::SharedMountProperty MGL::File::Mounter::Get ( const PathView & mountName )

nodiscardnoexcept

マウント情報を取得

引数

[in]

mountName

マウント名

戻り値

マウント情報．見つからない場合はnullptr

GetDelegate()

SharedDelegate MGL::File::Mounter::GetDelegate ( DelegateKey key = kDefaultDelegateKey )

nodiscardnoexcept

デリゲートを取得

引数

[in]

key

デリゲートキー

戻り値

キーに対応したデリゲート．失敗時にはnullptr

GetInstanceRef()

STL::unique_ptr< Mounter > & MGL::File::Mounter::GetInstanceRef ( )

staticnodiscardnoexcept

インスタンスの取得

戻り値

インスタンスの参照

IsMounted()

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

nodiscardnoexcept

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

引数

[in]

mountName

マウント名

戻り値

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

Mount()

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

noexcept

マウント

引数

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

戻り値

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

RemoveDelegate()

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

noexcept

デリゲートを削除

引数

[in]

key

デリゲートキー

戻り値

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

SetDefaultDelegate()

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

inlinenoexcept

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

引数

[in]

key

デフォルトのデリゲートキー

Unmount()

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

noexcept

マウント解除

引数

[in]

mountName

マウント名

戻り値

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

---

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

• /Users/acerola/x/mgl/include/mgl/file/mgl_file_mounter.h
• /Users/acerola/x/mgl/src/file/mgl_file_mounter.cc