SharpGrip.FileSystem 1.2.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
dotnet add package SharpGrip.FileSystem --version 1.2.0
NuGet\Install-Package SharpGrip.FileSystem -Version 1.2.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SharpGrip.FileSystem" Version="1.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SharpGrip.FileSystem --version 1.2.0
#r "nuget: SharpGrip.FileSystem, 1.2.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install SharpGrip.FileSystem as a Cake Addin
#addin nuget:?package=SharpGrip.FileSystem&version=1.2.0

// Install SharpGrip.FileSystem as a Cake Tool
#tool nuget:?package=SharpGrip.FileSystem&version=1.2.0

SharpGrip FileSystem NuGet

Builds

FileSystem [Build]

Quality Gate Status
Maintainability Rating
Reliability Rating
Security Rating
Coverage

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 NuGet NuGet
AmazonS3 SharpGrip.FileSystem.Adapters.AmazonS3 NuGet NuGet
AzureBlobStorage SharpGrip.FileSystem.Adapters.AzureBlobStorage NuGet NuGet
AzureFileStorage SharpGrip.FileSystem.Adapters.AzureFileStorage NuGet NuGet
Dropbox SharpGrip.FileSystem.Adapters.Dropbox NuGet NuGet
FTP SharpGrip.FileSystem.Adapters.Ftp NuGet NuGet
GoogleCloudStorage SharpGrip.FileSystem.Adapters.GoogleCloudStorage NuGet NuGet
GoogleDrive SharpGrip.FileSystem.Adapters.GoogleDrive NuGet NuGet
MicrosoftOneDrive SharpGrip.FileSystem.Adapters.MicrosoftOneDrive NuGet NuGet
SFTP SharpGrip.FileSystem.Adapters.Sftp NuGet NuGet

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 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (9)

Showing the top 5 NuGet packages that depend on SharpGrip.FileSystem:

Package Downloads
SharpGrip.FileSystem.Adapters.AzureBlobStorage The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

The SharpGrip FileSystem AzureBlobStorage adapter.

SharpGrip.FileSystem.Adapters.AzureFileStorage The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

The SharpGrip FileSystem AzureFileStorage adapter.

SharpGrip.FileSystem.Adapters.AmazonS3 The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

The SharpGrip FileSystem AmazonS3 adapter.

SharpGrip.FileSystem.Adapters.Sftp The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

The SharpGrip FileSystem SFTP adapter.

SharpGrip.FileSystem.Adapters.Dropbox The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

The SharpGrip FileSystem Dropbox adapter.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.0 65 5/23/2024
1.1.0 2,882 12/31/2023
1.0.0 1,112 8/5/2023
1.0.0-beta3 325 7/25/2023
1.0.0-beta2 411 5/9/2023
1.0.0-beta1 33,729 5/14/2022
1.0.0-alpha6 14,454 7/7/2020
1.0.0-alpha5 6,460 5/28/2020
1.0.0-alpha4 8,568 4/21/2020
1.0.0-alpha3 1,279 3/10/2020
1.0.0-alpha2 1,008 2/15/2020
1.0.0-alpha1 922 12/27/2019