SharpGrip.FileSystem
1.2.1
Prefix Reserved
dotnet add package SharpGrip.FileSystem --version 1.2.1
NuGet\Install-Package SharpGrip.FileSystem -Version 1.2.1
<PackageReference Include="SharpGrip.FileSystem" Version="1.2.1" />
paket add SharpGrip.FileSystem --version 1.2.1
#r "nuget: SharpGrip.FileSystem, 1.2.1"
// Install SharpGrip.FileSystem as a Cake Addin #addin nuget:?package=SharpGrip.FileSystem&version=1.2.1 // Install SharpGrip.FileSystem as a Cake Tool #tool nuget:?package=SharpGrip.FileSystem&version=1.2.1
SharpGrip FileSystem
Builds
Introduction
SharpGrip FileSystem is a versatile .NET file system abstraction that supports multiple storage adapters. It empowers developers to manage various file systems and services through a unified and easily comprehensible API. By coding against the abstractions provided by this library, developers can sidestep vendor-specific APIs, effectively avoiding vendor lock-ins. This flexibility enhances the portability and maintainability of the codebase, allowing for smoother transitions between different file systems.
Installation
Reference NuGet package SharpGrip.FileSystem
(https://www.nuget.org/packages/SharpGrip.FileSystem).
For adapters other than the local file system (included in the SharpGrip.FileSystem
package) please see the Supported adapters section.
Supported adapters
Adapter | Package | NuGet |
---|---|---|
Local adapter | SharpGrip.FileSystem |
|
AmazonS3 | SharpGrip.FileSystem.Adapters.AmazonS3 |
|
AzureBlobStorage | SharpGrip.FileSystem.Adapters.AzureBlobStorage |
|
AzureFileStorage | SharpGrip.FileSystem.Adapters.AzureFileStorage |
|
Dropbox | SharpGrip.FileSystem.Adapters.Dropbox |
|
FTP | SharpGrip.FileSystem.Adapters.Ftp |
|
GoogleCloudStorage | SharpGrip.FileSystem.Adapters.GoogleCloudStorage |
|
GoogleDrive | SharpGrip.FileSystem.Adapters.GoogleDrive |
|
MicrosoftOneDrive | SharpGrip.FileSystem.Adapters.MicrosoftOneDrive |
|
SFTP | SharpGrip.FileSystem.Adapters.Sftp |
Supported operations
For a full list of the supported operations please see the IFileSystem interface.
Usage
Instantiation
var adapters = new List<IAdapter>
{
new LocalAdapter("adapterPrefix", "adapterRootPath")
};
// Instantiation option 1.
var fileSystem = new FileSystem(adapters);
// Instantiation option 2.
var fileSystem = new FileSystem();
fileSystem.Adapters = adapters;
Local adapter
var adapters = new List<IAdapter>
{
new LocalAdapter("local1", "/var/files"),
new LocalAdapter("local2", "D:\\Files")
};
var fileSystem = new FileSystem(adapters);
Example operations
// Azure connection.
var azureClient = new ShareClient("connectionString", "shareName");
// Dropbox connection.
var dropboxClient = new DropboxClient("oAuth2AccessToken");
var adapters = new List<IAdapter>
{
new LocalAdapter("local", "/var/files"),
new AzureFileStorageAdapter("azure", "/Files", azureClient),
new DropboxAdapter("dropbox", "/Files", dropboxClient)
};
// Copies a file from the `local` adapter to the `azure` adapter.
await fileSystem.CopyFileAsync("local://foo/bar.txt", "azure://bar/foo.txt");
// Moves a file from the `azure` adapter to the `dropbox` adapter.
await fileSystem.MoveFileAsync("azure://Foo/Bar.txt", "dropbox://Bar/Foo.txt");
// Writes string contents to the `azure` adapter.
await fileSystem.WriteFileAsync("azure://Foo.txt", "Bar!");
// Reads a text file from the `dropbox` adapter.
var contents = fileSystem.ReadTextFileAsync("dropbox://Foo.txt");
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Microsoft.Extensions.Logging.Console (>= 8.0.0)
- MimeTypeMapOfficial (>= 1.0.17)
-
.NETStandard 2.1
- Microsoft.Extensions.Logging.Console (>= 8.0.0)
- MimeTypeMapOfficial (>= 1.0.17)
-
net6.0
- Microsoft.Extensions.Logging.Console (>= 8.0.0)
- MimeTypeMapOfficial (>= 1.0.17)
-
net7.0
- Microsoft.Extensions.Logging.Console (>= 8.0.0)
- MimeTypeMapOfficial (>= 1.0.17)
-
net8.0
- Microsoft.Extensions.Logging.Console (>= 8.0.0)
- MimeTypeMapOfficial (>= 1.0.17)
NuGet packages (9)
Showing the top 5 NuGet packages that depend on SharpGrip.FileSystem:
Package | Downloads |
---|---|
SharpGrip.FileSystem.Adapters.AzureBlobStorage
The SharpGrip FileSystem AzureBlobStorage adapter. |
|
SharpGrip.FileSystem.Adapters.AzureFileStorage
The SharpGrip FileSystem AzureFileStorage adapter. |
|
SharpGrip.FileSystem.Adapters.AmazonS3
The SharpGrip FileSystem AmazonS3 adapter. |
|
SharpGrip.FileSystem.Adapters.Sftp
The SharpGrip FileSystem SFTP adapter. |
|
SharpGrip.FileSystem.Adapters.Dropbox
The SharpGrip FileSystem Dropbox adapter. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.2.1 | 908 | 8/31/2024 |
1.2.0 | 1,980 | 5/23/2024 |
1.1.0 | 3,094 | 12/31/2023 |
1.0.0 | 1,783 | 8/5/2023 |
1.0.0-beta3 | 450 | 7/25/2023 |
1.0.0-beta2 | 526 | 5/9/2023 |
1.0.0-beta1 | 33,848 | 5/14/2022 |
1.0.0-alpha6 | 14,539 | 7/7/2020 |
1.0.0-alpha5 | 6,534 | 5/28/2020 |
1.0.0-alpha4 | 8,635 | 4/21/2020 |
1.0.0-alpha3 | 1,309 | 3/10/2020 |
1.0.0-alpha2 | 1,046 | 2/15/2020 |
1.0.0-alpha1 | 943 | 12/27/2019 |