mirrors/LibHac
1
0
Fork 0
mirror of https://github.com/Thealexbarney/LibHac.git synced 2024-11-14 10:49:41 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add basic docs for ConcatenationFileSystem

Browse source
This commit is contained in:
Alex Barney 2019-07-08 11:01:03 -05:00
parent 74a3929eb9
commit 90c048c389
1 changed files with 25 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
src/LibHac/Fs/ConcatenationFileSystem.cs
View file

@ -7,14 +7,39 @@ using System.Runtime.InteropServices;
namespace LibHac.Fs
{
/// <summary>
/// An <see cref="IFileSystem"/> that stores large files as smaller, separate sub-files.
/// </summary>
/// <remarks>
/// This filesystem is mainly used to allow storing large files on filesystems that have low
/// limits on file size such as FAT filesystems. The underlying base filesystem must have
/// support for the "Archive" file attribute found in FAT or NTFS filesystems.
///
/// A <see cref="ConcatenationFileSystem"/> may contain both standard files or Concatenation files.
/// If a directory has the archive attribute set, its contents will be concatenated and treated
/// as a single file. These sub-files must follow the naming scheme "00", "01", "02", ...
/// Each sub-file except the final one must have the size <see cref="SubFileSize"/> that was specified
/// at the creation of the <see cref="ConcatenationFileSystem"/>.
/// </remarks>
public class ConcatenationFileSystem : IFileSystem
{
private const long DefaultSubFileSize = 0xFFFF0000; // Hard-coded value used by FS
private IAttributeFileSystem BaseFileSystem { get; }
private long SubFileSize { get; }
/// <summary>
/// Initializes a new <see cref="ConcatenationFileSystem"/>.
/// </summary>
/// <param name="baseFileSystem">The base <see cref="IAttributeFileSystem"/> for the
/// new <see cref="ConcatenationFileSystem"/>.</param>
public ConcatenationFileSystem(IAttributeFileSystem baseFileSystem) : this(baseFileSystem, DefaultSubFileSize) { }
/// <summary>
/// Initializes a new <see cref="ConcatenationFileSystem"/>.
/// </summary>
/// <param name="baseFileSystem">The base <see cref="IAttributeFileSystem"/> for the
/// new <see cref="ConcatenationFileSystem"/>.</param>
/// <param name="subFileSize">The size of each sub-file. Once a file exceeds this size, a new sub-file will be created</param>
public ConcatenationFileSystem(IAttributeFileSystem baseFileSystem, long subFileSize)
{
BaseFileSystem = baseFileSystem;