Fp.Fs 0.27.1

.NET 6.0 .NET Standard 2.1 
dotnet add package Fp.Fs --version 0.27.1
NuGet\Install-Package Fp.Fs -Version 0.27.1
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="Fp.Fs" Version="0.27.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Fp.Fs --version 0.27.1
#r "nuget: Fp.Fs, 0.27.1"
#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 Fp.Fs as a Cake Addin
#addin nuget:?package=Fp.Fs&version=0.27.1

// Install Fp.Fs as a Cake Tool
#tool nuget:?package=Fp.Fs&version=0.27.1

.NET NuGet

File processing

Package Release
Fp NuGet
Fp.Fs NuGet
Fp.Plus NuGet
Fp.Platforms.Nitro NuGet
Fp.Templates NuGet

Documentation | Samples

Fp is designed as a framework for implementing concise data format extractors, primarily for archive containers and 2D rasters.

Many utilities for working with primitive data (including endianness-dependent I/O) are provided. See the Samples for more.

Libraries

  • Fp: Base file processing library
    • .NET Standard 2.1 / .NET 6.0
  • Fp.Fs: Filesystem processing library
    • .NET Standard 2.1 / .NET 6.0
  • Fp.Plus: Extension library (e.g. RGBA32 image (through ImageSharp) / PCM WAVE output)
    • .NET Standard 2.1 / .NET 6.0
  • Fp.Platforms.Nitro: Nintendo DS file format integrations
    • .NET Standard 2.1 / .NET 6.0

Scripting

  • fpx: Script execution program (thin wrapper of dotnet-script)
  • Dereliction: Basic Avalonia GUI script editor / testing program

Details

Filesystem processors are a unit worker derived from Fp.Fs.FsProcessor or one of its descendants that are called to operate on each applicable (by default, based on extension) file path, optionally opening a stream and generating console output or file artifacts. If written to only use compatible APIs (e.g. working with the FileSystemSource APIs and not directly using System.IO.File etc.), processors can be used to work with synthetic filesystems (e.g. directly working on files in a zip file) and more generally be used to efficiently interact with any binary data regardless of source.

File format processors are a unit worker derived from Fp.FormatSingleProcessor, Fp.FormatMultiProcessor, or one of their descendants. They can be used to efficiently obtain converted data from individual files, or be wrapped with FormatSingleProcessorFsWrapper / FormatMultiProcessorFsWrapper to be used as a FsProcessor.

Programs intended to extract from a set of files / folders (recursively) to a destination can utilize the default FsProcessor.Run<T> function where T is a user-created processor class. All file I/O is managed by the library, the processor will be automatically fed input file paths and can opt to open these files / create new files (automatically placed in the output directory) via the Processor class APIs.

Processors can be designed to generate a System.Collections.Generic.IEnumerable<Fp.Data> where Data represents an arbitrary content result with an associated filename, such as Fp.Plus.Images.Rgba32Data for an RGBA 32-bit image, or Fp.BufferData<byte> for an arbitrary byte buffer. This can be a useful pattern for designing an arbitrary import scheme for software that needs to be able to work with new file types without unnecessary pipeline changes.

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 was computed.  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 was computed.  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 netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen 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.

  • .NETStandard 2.1

    • Fp (>= 0.27.0)

  • net6.0

    • Fp (>= 0.27.0)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.27.1 408 9/6/2022
0.27.0 380 9/6/2022
0.26.0 437 1/31/2022
0.25.0 407 1/18/2022