README.md

Ramstack.FileSystem.Sub

Provides an implementation of Ramstack.FileSystem that wraps an underlying file system for managing files under a specific subpath.

Getting Started

To install the Ramstack.FileSystem.Sub NuGet package in your project, run the following command:

dotnet add package Ramstack.FileSystem.Sub

Usage

using Ramstack.FileSystem.Sub;

IVirtualFileSystem fileSystem = new PhysicalFileSystem(@"C:\project");

// Restrict the file system to only the contents within the "/app/assets" directory
// of the parent file system. Files and directories above the specified path will be inaccessible.
SubFileSystem fs = new SubFileSystem(path: "/app/assets", fileSystem);

await foreach (VirtualFile file in fs.GetFilesAsync("/"))
{
    Console.WriteLine(file.FullName);
}

Related Projects

• Ramstack.FileSystem.Abstractions - Provides a virtual file system abstraction.
• Ramstack.FileSystem.Physical - Provides an implementation based on the local file system.
• Ramstack.FileSystem.Azure - Provides an implementation using Azure Blob storage.
• Ramstack.FileSystem.Amazon - Provides an implementation using Amazon S3 storage.
• Ramstack.FileSystem.Google - Provides an implementation using Google Cloud storage.
• Ramstack.FileSystem.Readonly - Provides a read-only wrapper for the underlying file system.
• Ramstack.FileSystem.Globbing - Wraps the file system, filtering files and directories using glob patterns.
• Ramstack.FileSystem.Prefixed - Adds a prefix to file paths within the underlying file system.
• Ramstack.FileSystem.Adapters - Provides integration with Microsoft.Extensions.FileProviders.
• Ramstack.FileSystem.Composite - Provides an implementation that combines multiple file systems into a single composite file system.

Supported versions

	Version
.NET	6, 7, 8, 9, 10

Contributions

Bug reports and contributions are welcome.

License

This package is released as open source under the MIT License. See the LICENSE file for more details.