Mirror/LibHac
1
0
Fork 0
mirror of https://github.com/Thealexbarney/LibHac.git synced 2025-02-09 13:14:46 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add summary docs to ReadOnlySpan<byte> strings

Browse Source
This commit is contained in:
Alex Barney 2021-12-24 16:25:06 -07:00
parent 52d502a793
commit 5670f2fd48
4 changed files with 73 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
src/LibHac/Fs/AccessLog.cs
View File

@ -730,23 +730,29 @@ namespace LibHac.Fs.Impl
internal static class AccessLogStrings
{
/// <summary>"<c>$fs</c>"</summary>
public static ReadOnlySpan<byte> FsModuleName => // "$fs"
new[] { (byte)'$', (byte)'f', (byte)'s' };
public static ReadOnlySpan<byte> LogLibHacVersion => // "0.13.0"
/// <summary>"<c>0.15.0</c>"</summary>
public static ReadOnlySpan<byte> LogLibHacVersion => // "0.15.0"
new[]
{
(byte)'0', (byte)'.', (byte)'1', (byte)'3', (byte)'.', (byte)'0'
(byte)'0', (byte)'.', (byte)'1', (byte)'5', (byte)'.', (byte)'0'
};
/// <summary>"<c>"</c>"</summary>
public static byte LogQuote => (byte)'"';
/// <summary>"<c>true</c>"</summary>
public static ReadOnlySpan<byte> LogTrue => // "true"
new[] { (byte)'t', (byte)'r', (byte)'u', (byte)'e' };
/// <summary>"<c>false</c>"</summary>
public static ReadOnlySpan<byte> LogFalse => // "false"
new[] { (byte)'f', (byte)'a', (byte)'l', (byte)'s', (byte)'e' };
/// <summary>"<c>, entry_buffer_count: </c>"</summary>
public static ReadOnlySpan<byte> LogEntryBufferCount => // ", entry_buffer_count: "
new[]
{
@ -755,6 +761,7 @@ namespace LibHac.Fs.Impl
(byte)'o', (byte)'u', (byte)'n', (byte)'t', (byte)':', (byte)' '
};
/// <summary>"<c>, entry_count: </c>"</summary>
public static ReadOnlySpan<byte> LogEntryCount => // ", entry_count: "
new[]
{
@ -762,6 +769,7 @@ namespace LibHac.Fs.Impl
(byte)'c', (byte)'o', (byte)'u', (byte)'n', (byte)'t', (byte)':', (byte)' '
};
/// <summary>"<c>, offset: </c>"</summary>
public static ReadOnlySpan<byte> LogOffset => // ", offset: "
new[]
{
@ -769,12 +777,14 @@ namespace LibHac.Fs.Impl
(byte)':', (byte)' '
};
/// <summary>"<c>, size: </c>"</summary>
public static ReadOnlySpan<byte> LogSize => // ", size: "
new[]
{
(byte)',', (byte)' ', (byte)'s', (byte)'i', (byte)'z', (byte)'e', (byte)':', (byte)' '
};
/// <summary>"<c>, read_size: </c>"</summary>
public static ReadOnlySpan<byte> LogReadSize => // ", read_size: "
new[]
{
@ -782,6 +792,7 @@ namespace LibHac.Fs.Impl
(byte)'i', (byte)'z', (byte)'e', (byte)':', (byte)' '
};
/// <summary>"<c>, write_option: Flush</c>"</summary>
public static ReadOnlySpan<byte> LogWriteOptionFlush => // ", write_option: Flush"
new[]
{
@ -790,6 +801,7 @@ namespace LibHac.Fs.Impl
(byte)'F', (byte)'l', (byte)'u', (byte)'s', (byte)'h'
};
/// <summary>"<c>, open_mode: 0x</c>"</summary>
public static ReadOnlySpan<byte> LogOpenMode => // ", open_mode: 0x"
new[]
{
@ -797,6 +809,7 @@ namespace LibHac.Fs.Impl
(byte)'o', (byte)'d', (byte)'e', (byte)':', (byte)' ', (byte)'0', (byte)'x'
};
/// <summary>"<c>, path: "</c>"</summary>
public static ReadOnlySpan<byte> LogPath => // ", path: ""
new[]
{
@ -804,6 +817,7 @@ namespace LibHac.Fs.Impl
(byte)'"'
};
/// <summary>"<c>", new_path: "</c>"</summary>
public static ReadOnlySpan<byte> LogNewPath => // "", new_path: ""
new[]
{
@ -811,6 +825,7 @@ namespace LibHac.Fs.Impl
(byte)'a', (byte)'t', (byte)'h', (byte)':', (byte)' ', (byte)'"'
};
/// <summary>"<c>", entry_type: </c>"</summary>
public static ReadOnlySpan<byte> LogEntryType => // "", entry_type: "
new[]
{
@ -818,6 +833,7 @@ namespace LibHac.Fs.Impl
(byte)'_', (byte)'t', (byte)'y', (byte)'p', (byte)'e', (byte)':', (byte)' '
};
/// <summary>"<c>, name: "</c>"</summary>
public static ReadOnlySpan<byte> LogName => // ", name: ""
new[]
{
@ -825,6 +841,7 @@ namespace LibHac.Fs.Impl
(byte)'"'
};
/// <summary>"<c>", commit_option: 0x</c>"</summary>
public static ReadOnlySpan<byte> LogCommitOption => // "", commit_option: 0x"
new[]
{
@ -833,6 +850,7 @@ namespace LibHac.Fs.Impl
(byte)':', (byte)' ', (byte)'0', (byte)'x'
};
/// <summary>"<c>", is_mounted: "</c>"</summary>
public static ReadOnlySpan<byte> LogIsMounted => // "", is_mounted: ""
new[]
{
@ -840,6 +858,7 @@ namespace LibHac.Fs.Impl
(byte)'u', (byte)'n', (byte)'t', (byte)'e', (byte)'d', (byte)':', (byte)' ', (byte)'"'
};
/// <summary>"<c>, applicationid: 0x</c>"</summary>
public static ReadOnlySpan<byte> LogApplicationId => // ", applicationid: 0x"
new[]
{
@ -848,6 +867,7 @@ namespace LibHac.Fs.Impl
(byte)' ', (byte)'0', (byte)'x'
};
/// <summary>"<c>, programid: 0x</c>"</summary>
public static ReadOnlySpan<byte> LogProgramId => // ", programid: 0x"
new[]
{
@ -855,6 +875,7 @@ namespace LibHac.Fs.Impl
(byte)'m', (byte)'i', (byte)'d', (byte)':', (byte)' ', (byte)'0', (byte)'x'
};
/// <summary>"<c>, dataid: 0x</c>"</summary>
public static ReadOnlySpan<byte> LogDataId => // ", dataid: 0x"
new[]
{
@ -862,6 +883,7 @@ namespace LibHac.Fs.Impl
(byte)':', (byte)' ', (byte)'0', (byte)'x'
};
/// <summary>"<c>, bispartitionid: </c>"</summary>
public static ReadOnlySpan<byte> LogBisPartitionId => // ", bispartitionid: "
new[]
{
@ -870,6 +892,7 @@ namespace LibHac.Fs.Impl
(byte)':', (byte)' '
};
/// <summary>"<c>, content_type: </c>"</summary>
public static ReadOnlySpan<byte> LogContentType => // ", content_type: "
new[]
{
@ -877,6 +900,7 @@ namespace LibHac.Fs.Impl
(byte)'t', (byte)'_', (byte)'t', (byte)'y', (byte)'p', (byte)'e', (byte)':', (byte)' '
};
/// <summary>"<c>, contentstorageid: </c>"</summary>
public static ReadOnlySpan<byte> LogContentStorageId => // ", contentstorageid: "
new[]
{
@ -885,6 +909,7 @@ namespace LibHac.Fs.Impl
(byte)'i', (byte)'d', (byte)':', (byte)' '
};
/// <summary>"<c>, gamecard_handle: 0x</c>"</summary>
public static ReadOnlySpan<byte> LogGameCardHandle => // ", gamecard_handle: 0x"
new[]
{
@ -893,6 +918,7 @@ namespace LibHac.Fs.Impl
(byte)'e', (byte)':', (byte)' ', (byte)'0', (byte)'x'
};
/// <summary>"<c>, gamecard_partition: </c>"</summary>
public static ReadOnlySpan<byte> LogGameCardPartition => // ", gamecard_partition: "
new[]
{
@ -901,6 +927,7 @@ namespace LibHac.Fs.Impl
(byte)'t', (byte)'i', (byte)'o', (byte)'n', (byte)':', (byte)' '
};
/// <summary>"<c>, mount_host_option: </c>"</summary>
public static ReadOnlySpan<byte> LogMountHostOption => // ", mount_host_option: "
new[]
{
@ -909,6 +936,7 @@ namespace LibHac.Fs.Impl
(byte)'i', (byte)'o', (byte)'n', (byte)':', (byte)' '
};
/// <summary>"<c>, root_path: "</c>"</summary>
public static ReadOnlySpan<byte> LogRootPath => // ", root_path: ""
new[]
{
@ -916,6 +944,7 @@ namespace LibHac.Fs.Impl
(byte)'a', (byte)'t', (byte)'h', (byte)':', (byte)' ', (byte)'"'
};
/// <summary>"<c>, userid: 0x</c>"</summary>
public static ReadOnlySpan<byte> LogUserId => // ", userid: 0x"
new[]
{
@ -923,6 +952,7 @@ namespace LibHac.Fs.Impl
(byte)':', (byte)' ', (byte)'0', (byte)'x'
};
/// <summary>"<c>, index: </c>"</summary>
public static ReadOnlySpan<byte> LogIndex => // ", index: "
new[]
{
@ -930,6 +960,7 @@ namespace LibHac.Fs.Impl
(byte)' '
};
/// <summary>"<c>, save_data_owner_id: 0x</c>"</summary>
public static ReadOnlySpan<byte> LogSaveDataOwnerId => // ", save_data_owner_id: 0x"
new[]
{
@ -938,6 +969,7 @@ namespace LibHac.Fs.Impl
(byte)'r', (byte)'_', (byte)'i', (byte)'d', (byte)':', (byte)' ', (byte)'0', (byte)'x'
};
/// <summary>"<c>, save_data_size: </c>"</summary>
public static ReadOnlySpan<byte> LogSaveDataSize => // ", save_data_size: "
new[]
{
@ -946,6 +978,7 @@ namespace LibHac.Fs.Impl
(byte)':', (byte)' '
};
/// <summary>"<c>, save_data_journal_size: </c>"</summary>
public static ReadOnlySpan<byte> LogSaveDataJournalSize => // ", save_data_journal_size: "
new[]
{
@ -955,6 +988,7 @@ namespace LibHac.Fs.Impl
(byte)':', (byte)' '
};
/// <summary>"<c>, save_data_flags: 0x</c>"</summary>
public static ReadOnlySpan<byte> LogSaveDataFlags => // ", save_data_flags: 0x"
new[]
{
@ -963,6 +997,7 @@ namespace LibHac.Fs.Impl
(byte)'s', (byte)':', (byte)' ', (byte)'0', (byte)'x'
};
/// <summary>"<c>, savedataid: 0x</c>"</summary>
public static ReadOnlySpan<byte> LogSaveDataId => // ", savedataid: 0x"
new[]
{
@ -970,6 +1005,7 @@ namespace LibHac.Fs.Impl
(byte)'t', (byte)'a', (byte)'i', (byte)'d', (byte)':', (byte)' ', (byte)'0', (byte)'x'
};
/// <summary>"<c>, savedataspaceid: </c>"</summary>
public static ReadOnlySpan<byte> LogSaveDataSpaceId => // ", savedataspaceid: "
new[]
{
@ -978,6 +1014,7 @@ namespace LibHac.Fs.Impl
(byte)'d', (byte)':', (byte)' '
};
/// <summary>"<c>, save_data_time_stamp: </c>"</summary>
public static ReadOnlySpan<byte> LogSaveDataTimeStamp => // ", save_data_time_stamp: "
new[]
{
@ -986,6 +1023,7 @@ namespace LibHac.Fs.Impl
(byte)'_', (byte)'s', (byte)'t', (byte)'a', (byte)'m', (byte)'p', (byte)':', (byte)' '
};
/// <summary>"<c>, save_data_commit_id: 0x</c>"</summary>
public static ReadOnlySpan<byte> LogSaveDataCommitId => // ", save_data_commit_id: 0x"
new[]
{
@ -995,6 +1033,7 @@ namespace LibHac.Fs.Impl
(byte)'x'
};
/// <summary>"<c>, restore_flag: </c>"</summary>
public static ReadOnlySpan<byte> LogRestoreFlag => // ", restore_flag: "
new[]
{
@ -1002,6 +1041,7 @@ namespace LibHac.Fs.Impl
(byte)'e', (byte)'_', (byte)'f', (byte)'l', (byte)'a', (byte)'g', (byte)':', (byte)' '
};
/// <summary>"<c>sdk_version: </c>"</summary>
public static ReadOnlySpan<byte> LogSdkVersion => // "sdk_version: "
new[]
{
@ -1009,15 +1049,18 @@ namespace LibHac.Fs.Impl
(byte)'i', (byte)'o', (byte)'n', (byte)':', (byte)' '
};
/// <summary>"<c>, spec: </c>"</summary>
public static ReadOnlySpan<byte> LogSpec => // ", spec: "
new[]
{
(byte)',', (byte)' ', (byte)'s', (byte)'p', (byte)'e', (byte)'c', (byte)':', (byte)' '
};
/// <summary>"<c>NX</c>"</summary>
public static ReadOnlySpan<byte> LogNx => // "NX"
new[] { (byte)'N', (byte)'X' };
/// <summary>"<c>, program_index: </c>"</summary>
public static ReadOnlySpan<byte> LogProgramIndex => // ", program_index: "
new[]
{
@ -1026,6 +1069,7 @@ namespace LibHac.Fs.Impl
(byte)' '
};
/// <summary>"<c>, for_system: true</c>"</summary>
public static ReadOnlySpan<byte> LogForSystem => // ", for_system: true"
new[]
{
@ -1034,6 +1078,7 @@ namespace LibHac.Fs.Impl
(byte)'u', (byte)'e'
};
/// <summary>"<c>"FS_ACCESS: { </c>"</summary>
public static ReadOnlySpan<byte> LogLineStart => // "FS_ACCESS: { "
new[]
{
@ -1041,21 +1086,25 @@ namespace LibHac.Fs.Impl
(byte)'S', (byte)':', (byte)' ', (byte)'{', (byte)' '
};
/// <summary>"<c> }\n</c>"</summary>
public static ReadOnlySpan<byte> LogLineEnd => // " }\n"
new[] { (byte)' ', (byte)'}', (byte)'\n' };
/// <summary>"<c>start: </c>"</summary>
public static ReadOnlySpan<byte> LogStart => // "start: "
new[]
{
(byte)'s', (byte)'t', (byte)'a', (byte)'r', (byte)'t', (byte)':', (byte)' '
};
/// <summary>"<c>, end: </c>"</summary>
public static ReadOnlySpan<byte> LogEnd => // ", end: "
new[]
{
(byte)',', (byte)' ', (byte)'e', (byte)'n', (byte)'d', (byte)':', (byte)' '
};
/// <summary>"<c>, result: 0x</c>"</summary>
public static ReadOnlySpan<byte> LogResult => // ", result: 0x"
new[]
{
@ -1063,6 +1112,7 @@ namespace LibHac.Fs.Impl
(byte)':', (byte)' ', (byte)'0', (byte)'x'
};
/// <summary>"<c>, handle: 0x</c>"</summary>
public static ReadOnlySpan<byte> LogHandle => // ", handle: 0x"
new[]
{
@ -1070,6 +1120,7 @@ namespace LibHac.Fs.Impl
(byte)':', (byte)' ', (byte)'0', (byte)'x'
};
/// <summary>"<c>, priority: </c>"</summary>
public static ReadOnlySpan<byte> LogPriority => // ", priority: "
new[]
{
@ -1077,6 +1128,7 @@ namespace LibHac.Fs.Impl
(byte)'t', (byte)'y', (byte)':', (byte)' '
};
/// <summary>"<c>, function: "</c>"</summary>
public static ReadOnlySpan<byte> LogFunction => // ", function: ""
new[]
{
@ -1084,4 +1136,4 @@ namespace LibHac.Fs.Impl
(byte)'o', (byte)'n', (byte)':', (byte)' ', (byte)'"'
};
}
}
}

14
src/LibHac/Fs/Fsa/FileSystemAccessor.cs
View File

@ -525,8 +525,10 @@ internal class FileSystemAccessor : IDisposable
Remove(_openDirectories, directory);
}
/// <summary>"<c>$fs</c>"</summary>
private static ReadOnlySpan<byte> LogFsModuleName => new[] { (byte)'$', (byte)'f', (byte)'s' }; // "$fs"
/// <summary>"<c>------ FS ERROR INFORMATION ------\n</c>"</summary>
private static ReadOnlySpan<byte> LogFsErrorInfo => // "------ FS ERROR INFORMATION ------\n"
new[]
{
@ -537,6 +539,7 @@ internal class FileSystemAccessor : IDisposable
(byte)'-', (byte)'-', (byte)'\\', (byte)'n'
};
/// <summary>"<c>Error: File not closed</c>"</summary>
private static ReadOnlySpan<byte> LogFileNotClosed => // "Error: File not closed"
new[]
{
@ -545,6 +548,7 @@ internal class FileSystemAccessor : IDisposable
(byte)'c', (byte)'l', (byte)'o', (byte)'s', (byte)'e', (byte)'d'
};
/// <summary>"<c>Error: Directory not closed</c>"</summary>
private static ReadOnlySpan<byte> LogDirectoryNotClosed => // "Error: Directory not closed"
new[]
{
@ -554,6 +558,7 @@ internal class FileSystemAccessor : IDisposable
(byte)'s', (byte)'e', (byte)'d'
};
/// <summary>"<c> (mount_name: "</c>"</summary>
private static ReadOnlySpan<byte> LogMountName => // " (mount_name: ""
new[]
{
@ -561,6 +566,7 @@ internal class FileSystemAccessor : IDisposable
(byte)'n', (byte)'a', (byte)'m', (byte)'e', (byte)':', (byte)' ', (byte)'"'
};
/// <summary>"<c>", count: </c>"</summary>
private static ReadOnlySpan<byte> LogCount => // "", count: "
new[]
{
@ -568,10 +574,13 @@ internal class FileSystemAccessor : IDisposable
(byte)':', (byte)' '
};
/// <summary>"<c>)\n</c>"</summary>
public static ReadOnlySpan<byte> LogLineEnd => new[] { (byte)')', (byte)'\\', (byte)'n' }; // ")\n"
/// <summary>"<c> | </c>"</summary>
public static ReadOnlySpan<byte> LogOrOperator => new[] { (byte)' ', (byte)'|', (byte)' ' }; // " | "
/// <summary>"<c>OpenMode_Read</c>"</summary>
private static ReadOnlySpan<byte> LogOpenModeRead => // "OpenMode_Read"
new[]
{
@ -579,6 +588,7 @@ internal class FileSystemAccessor : IDisposable
(byte)'_', (byte)'R', (byte)'e', (byte)'a', (byte)'d'
};
/// <summary>"<c>OpenMode_Write</c>"</summary>
private static ReadOnlySpan<byte> LogOpenModeWrite => // "OpenMode_Write"
new[]
{
@ -586,6 +596,7 @@ internal class FileSystemAccessor : IDisposable
(byte)'_', (byte)'W', (byte)'r', (byte)'i', (byte)'t', (byte)'e'
};
/// <summary>"<c>OpenMode_AllowAppend</c>"</summary>
private static ReadOnlySpan<byte> LogOpenModeAppend => // "OpenMode_AllowAppend"
new[]
{
@ -594,6 +605,7 @@ internal class FileSystemAccessor : IDisposable
(byte)'p', (byte)'e', (byte)'n', (byte)'d'
};
/// <summary>"<c> handle: 0x</c>"</summary>
private static ReadOnlySpan<byte> LogHandle => // " handle: 0x"
new[]
{
@ -601,6 +613,7 @@ internal class FileSystemAccessor : IDisposable
(byte)'d', (byte)'l', (byte)'e', (byte)':', (byte)' ', (byte)'0', (byte)'x'
};
/// <summary>"<c>, open_mode: </c>"</summary>
private static ReadOnlySpan<byte> LogOpenMode => // ", open_mode: "
new[]
{
@ -608,6 +621,7 @@ internal class FileSystemAccessor : IDisposable
(byte)'o', (byte)'d', (byte)'e', (byte)':', (byte)' '
};
/// <summary>"<c>, size:</c>"</summary>
private static ReadOnlySpan<byte> LogSize => // ", size: "
new[]
{

3
src/LibHac/FsSrv/AccessLogService.cs
View File

@ -63,6 +63,7 @@ internal readonly struct AccessLogService
return _serviceImpl.GetProgramInfo(out programInfo, _processId);
}
/// <summary>"<c>FS_ACCESS: { multi_program_tag: true }\n</c>"</summary>
private static ReadOnlySpan<byte> MultiProgramTag => // FS_ACCESS: { multi_program_tag: true }\n
new[]
{
@ -72,4 +73,4 @@ internal readonly struct AccessLogService
(byte) 'a', (byte) 'm', (byte) '_', (byte) 't', (byte) 'a', (byte) 'g', (byte) ':', (byte) ' ',
(byte) 't', (byte) 'r', (byte) 'u', (byte) 'e', (byte) ' ', (byte) '}', (byte) '\n'
};
}
}

4
src/LibHac/FsSrv/Impl/MultiCommitManager.cs
View File

@ -55,7 +55,7 @@ internal class MultiCommitManager : IMultiCommitManager
private const int CurrentCommitContextVersion = 0x10000;
private const long CommitContextFileSize = 0x200;
// /commitinfo
/// <summary>"<c>/commitinfo</c>"</summary>
private static ReadOnlySpan<byte> CommitContextFileName =>
new[] { (byte)'/', (byte)'c', (byte)'o', (byte)'m', (byte)'m', (byte)'i', (byte)'t', (byte)'i', (byte)'n', (byte)'f', (byte)'o' };
@ -640,4 +640,4 @@ internal class MultiCommitManager : IMultiCommitManager
return Result.Success;
}
}
}
}