mgl_file_defs.h ファイル

MGL ファイル用各種定義 [詳解]

#include <cstdint>
#include <mgl/common/mgl_result_wrapper.h>
#include <mgl/hash/mgl_hash_fnv1a.h>
#include <mgl/stl/mgl_stl_memory.h>

[ソースコード]

型定義
using	MGL::File::SharedDelegate = std::shared_ptr<Delegate>
	デリゲートの共有ポインタ
using	MGL::File::Result = MGL::ResultWrapper<Error, Error::None, Error::NoOperation>
	ファイル関連の処理結果

列挙型
enum class	MGL::File::DelegateKey : uint32_t
	デリゲートキーの型
enum class	MGL::File::OpenMode : uint8_t { None , Read , Write }
	オープンモード [詳解]
enum class	MGL::File::MountAccessType : uint8_t { ReadOnly , Writable }
	マウント時のアクセスタイプ [詳解]
enum class	MGL::File::SeekType : uint8_t { Top , End , Current }
	シークタイプ [詳解]
enum class	MGL::File::Error : uint16_t {   None = 0 , NoOperation = 100 , NotImplemented = 101 , NotSupported = 102 ,   InvalidDelegate = 103 , InvalidArgument = 104 , InvalidPathFormat = 105 , BadImplement = 106 ,   DelegateAlreadyExist = 200 , DelegateNotExist = 201 , NotMounted = 202 , AlreadyMounted = 203 ,   MountNotWritable = 204 , MountFailed = 205 , NotOpened = 206 , NotReadableMode = 207 ,   NotWritableMode = 208 , NoSystemNativeFile = 209 , NoRegularFile = 210 , FileNotExist = 300 ,   FileAlreadyExist = 301 , PathNotFound = 302 , NotPermitted = 303 , NoSpaceStorage = 304 ,   ReadError = 305 , WriteError = 306 , UnknownError = 999 }
	エラー定義 [詳解]

関数
constexpr DelegateKey	MGL::File::MakeDelegateKey (const char *keyString, uint32_t seed=kDefaultDelegateKeySeed) noexcept
	デリゲートキーの生成

変数
constexpr uint32_t	MGL::File::kDefaultDelegateKeySeed = MGL::Hash::kFNV1aDefaultValue32
	デリゲートキーのハッシュ生成に使用するシード値

詳解

MGL ファイル用各種定義

日付

Since: January 20, 2021. 10:05:04 JST.

著者

Acerola

列挙型詳解

Error

enum class MGL::File::Error : uint16_t

strong

エラー定義

列挙値
None	エラーなし（成功）
NoOperation	処理していない
NotImplemented	未実装
NotSupported	指定された操作に対応していない
InvalidDelegate	デリゲートが不正
InvalidArgument	引数が不正
InvalidPathFormat	パスの書式が不正
BadImplement	実装上の不正
DelegateAlreadyExist	デリゲートが既に存在している
DelegateNotExist	デリゲートが存在しない
NotMounted	マウントされていない
AlreadyMounted	既にマウントされている
MountNotWritable	書き込み不可能なマウントに対する書き込み操作を行おうとしている
MountFailed	マウントに失敗
NotOpened	オープンされていない
NotReadableMode	読み込み用にオープンされていない
NotWritableMode	書き込み用にオープンされていない
NoSystemNativeFile	対象がシステム標準のファイルではない
NoRegularFile	通常ファイルではない
FileNotExist	ファイルが存在しない
FileAlreadyExist	ファイルが既に存在している
PathNotFound	パスが存在しない
NotPermitted	ファイルにアクセスする権限がない
NoSpaceStorage	保存領域の容量不足
ReadError	読み込みに失敗
WriteError	書き込みに失敗
UnknownError	不明なエラー

MountAccessType

enum class MGL::File::MountAccessType : uint8_t

strong

マウント時のアクセスタイプ

列挙値
ReadOnly	読み込み専用
Writable	書き込み可能

OpenMode

enum class MGL::File::OpenMode : uint8_t

strong

オープンモード

列挙値
None	無効
Read	読み込み
Write	書き込み

SeekType

enum class MGL::File::SeekType : uint8_t

strong

シークタイプ

列挙値
Top	先頭から
End	末尾から
Current	現在の位置から

関数詳解

MakeDelegateKey()

DelegateKey MGL::File::MakeDelegateKey ( const char * keyString, uint32_t seed = kDefaultDelegateKeySeed )

nodiscardconstexprnoexcept

デリゲートキーの生成

引数

[in]	keyString	キーの文字列
[in]	seed	シード値（省略時はkDefaultDelegateKeySeed）

戻り値

生成したデリゲートキー