Cloudenum.FileDetective 1.0.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package Cloudenum.FileDetective --version 1.0.1
                    
NuGet\Install-Package Cloudenum.FileDetective -Version 1.0.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="Cloudenum.FileDetective" Version="1.0.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Cloudenum.FileDetective" Version="1.0.1" />
                    
Directory.Packages.props
<PackageReference Include="Cloudenum.FileDetective" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Cloudenum.FileDetective --version 1.0.1
                    
#r "nuget: Cloudenum.FileDetective, 1.0.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.
#:package Cloudenum.FileDetective@1.0.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Cloudenum.FileDetective&version=1.0.1
                    
Install as a Cake Addin
#tool nuget:?package=Cloudenum.FileDetective&version=1.0.1
                    
Install as a Cake Tool

Cloudenum.FileDetective

A C# library to detect file types by analyzing their content.

Usage

using Cloudenum.FileDetective;

using (var file = File.OpenRead("path/to/file"))
{
    string mimeType = FileType.GetMimeType(file);
    Console.WriteLine(mimeType);

    string[] extensions = FileType.GetExtensions(file);
    foreach (string extension in extensions)
    {
        Console.WriteLine(extension);
    }
})

Write Your Own File Detector

You can create a custom file detector by implementing the IFileDetector interface. Then register it using the FileType.RegisterFileDetector method before using this library.
You can register it during program startup (e.g. in Program.cs or Startup.cs).

FileType.RegisterFileDetector<CustomFileDetector>();

For easier implementation, you can inherit from these abstract classes:

  • AbstractRegexDetector for regex-based detection.
  • AbstractSignatureDetector for detection based on file signatures.
  • AbstractSignatureSequenceDetector for detection based on file signature sequences.
  • AbstractTextDetector for text-based detection.
  • AbstractZipBasedDetector for detection based on ZIP file structure.
public class CustomFileDetector : AbstractSignatureDetector
{
    public override string Description { get; } = "Custom File";
    public override string MimeType { get; } = "application/custom";
    public override FileSignature[] Signatures { get; } = {
        new FileSignature() {
            Offset = 0,
            MagicBytes = new byte[] { 0xFF, 0xFF, 0xFF, 0xFF },
        },
    }
}

Limitations

  • Currently, detection for text files only support Windows and Linux.
  • There may be some false positives if the file has been modified in such a way to appear as another file type.

License

This project is licensed under the Mozilla Public License 2.0 - see the LICENSE file for details.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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 was computed. 
.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

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
1.0.2 508 3/25/2025
1.0.1 343 3/24/2025