Vali-FileSize 1.1.1

Vali-FileSize

Lightweight .NET library for file size conversion, formatting and automatic unit detection.

Table of Contents

• Installation
• Quick Start
• API Reference
  • Convert
  • FormatSize
  • GetBestUnit
  • FormatBestSize
• Extension Methods
• IEC / Binary Prefixes
• Dependency Injection
• Supported Units
• Donations
• License

Installation

dotnet add package Vali-FileSize

Supports .NET Standard 2.0 and 2.1, .NET 6, 7, 8 and 9.

Quick Start

using ValiFileSize.Core.Main;
using ValiFileSize.Core.Enums;

var fs = new ValiFileSize();

// Convert 2.5 GB → KB
double kb = fs.Convert(2.5, FileSizeUnit.Gigabytes, FileSizeUnit.Kilobytes);
Console.WriteLine(kb); // 2621440

// Format a raw byte count with automatic unit selection
string label = fs.FormatBestSize(1_234_567_890);
Console.WriteLine(label); // "1.15 GB"

Or even shorter with extension methods:

using ValiFileSize.Core.Extensions;

string label = 1_234_567_890L.FormatBestSize(); // "1.15 GB"

API Reference

Convert

Converts a value from one unit to another. All units use the binary base (1 024).

double Convert(double size, FileSizeUnit fromUnit, FileSizeUnit toUnit)

// 1.5 TB → bytes
double bytes = fs.Convert(1.5, FileSizeUnit.Terabytes, FileSizeUnit.Bytes);
// 1 649 267 441 664

// 512 MB → GB
double gb = fs.Convert(512, FileSizeUnit.Megabytes, FileSizeUnit.Gigabytes);
// 0.5

// Exabytes
double eb = fs.Convert(2, FileSizeUnit.Exabytes, FileSizeUnit.Petabytes);
// 2 048

// IEC units follow the same 1 024 base, different display suffix
double b = fs.Convert(1, FileSizeUnit.Mebibytes, FileSizeUnit.Bytes);
// 1 048 576

Exceptions

FormatSize

Formats a value as a human-readable string.

string FormatSize(double size, FileSizeUnit unit, int decimalPlaces = 2, CultureInfo? culture = null)

fs.FormatSize(1.5, FileSizeUnit.Megabytes);                          // "1.50 MB"
fs.FormatSize(1.23456, FileSizeUnit.Gigabytes, decimalPlaces: 4);   // "1.2346 GB"
fs.FormatSize(512, FileSizeUnit.Bytes, decimalPlaces: 0);            // "512 B"
fs.FormatSize(1.0, FileSizeUnit.Exabytes);                           // "1.00 EB"

// IEC suffix
fs.FormatSize(1.0, FileSizeUnit.Gibibytes);                          // "1.00 GiB"
fs.FormatSize(1.0, FileSizeUnit.Exbibytes);                          // "1.00 EiB"

// Cultural formatting
var de = new CultureInfo("de-DE");
fs.FormatSize(1234.5, FileSizeUnit.Kilobytes, 2, de);               // "1234,50 KB"

Exceptions

GetBestUnit

Selects the most appropriate unit for a byte count and returns the converted value.

(double size, FileSizeUnit unit) GetBestUnit(double bytes, bool useIec = false)

var (size, unit) = fs.GetBestUnit(1_234_567_890);
// size = 1.15, unit = FileSizeUnit.Gigabytes

var (size2, unit2) = fs.GetBestUnit(1_048_576, useIec: true);
// size2 = 1.0, unit2 = FileSizeUnit.Mebibytes

double oneEB = 1024.0 * 1024 * 1024 * 1024 * 1024 * 1024;
var (size3, unit3) = fs.GetBestUnit(oneEB);
// size3 = 1.0, unit3 = FileSizeUnit.Exabytes

FormatBestSize

Combines GetBestUnit + FormatSize in a single call — the most convenient method for displaying raw byte counts.

string FormatBestSize(double bytes, int decimalPlaces = 2, CultureInfo? culture = null, bool useIec = false)

fs.FormatBestSize(0);                                   // "0.00 B"
fs.FormatBestSize(2048);                                // "2.00 KB"
fs.FormatBestSize(1_234_567_890);                       // "1.15 GB"
fs.FormatBestSize(1_234_567_890, decimalPlaces: 4);     // "1.1498 GB"
fs.FormatBestSize(1_048_576, useIec: true);             // "1.00 MiB"

var de = new CultureInfo("de-DE");
fs.FormatBestSize(1_234_567_890, culture: de);          // "1,15 GB"

Before vs. After

// Before — manual, error-prone
double bytes  = 2.5 * 1024 * 1024 * 1024;
string result = $"{bytes / 1024 / 1024 / 1024:F2} GB"; // "2.50 GB"

// After — one line
string result = fs.FormatBestSize(2.5 * 1024 * 1024 * 1024); // "2.50 GB"

Extension Methods

Add using ValiFileSize.Core.Extensions; to use extension methods directly on double and long values — no need to instantiate ValiFileSize manually.

ToFormattedSize

Formats a known-unit value as a string.

1.5.ToFormattedSize(FileSizeUnit.Megabytes);                    // "1.50 MB"
1024L.ToFormattedSize(FileSizeUnit.Kilobytes, decimalPlaces: 0); // "1024 KB"
1.0.ToFormattedSize(FileSizeUnit.Exbibytes);                    // "1.00 EiB"

var de = new CultureInfo("de-DE");
1.5.ToFormattedSize(FileSizeUnit.Megabytes, 2, de);             // "1,50 MB"

FormatBestSize

Treats the value as bytes, auto-detects the best unit, and returns a formatted string.

512L.FormatBestSize();                       // "512.00 B"
2048L.FormatBestSize();                      // "2.00 KB"
1_234_567_890L.FormatBestSize();             // "1.15 GB"
1_234_567_890L.FormatBestSize(useIec: true); // "1.15 GiB"

GetBestUnit

Treats the value as bytes and returns the best unit as a tuple.

var (size, unit) = 1_048_576L.GetBestUnit();
// size = 1.0, unit = FileSizeUnit.Megabytes

var (size2, unit2) = 1_048_576L.GetBestUnit(useIec: true);
// size2 = 1.0, unit2 = FileSizeUnit.Mebibytes

IEC / Binary Prefixes

The IEC 80000-13 standard distinguishes between decimal (SI) and binary prefixes. Vali-FileSize uses binary (1 024-based) math for all units. Pass useIec: true to display the unambiguous IEC suffixes (KiB, MiB, GiB…).

// Same data, two display conventions
fs.FormatBestSize(1_048_576);               // "1.00 MB"  ← traditional
fs.FormatBestSize(1_048_576, useIec: true); // "1.00 MiB" ← IEC

You can also use IEC units explicitly in Convert and FormatSize:

fs.FormatSize(fs.Convert(500, FileSizeUnit.Mebibytes, FileSizeUnit.Gibibytes), FileSizeUnit.Gibibytes, 3);
// "0.488 GiB"

Dependency Injection

ValiFileSize implements IValiFileSize. Register it in your DI container to decouple your code from the concrete class.

// ASP.NET Core / Generic Host
builder.Services.AddSingleton<IValiFileSize, ValiFileSize>();

// Usage via constructor injection
public class FileService(IValiFileSize fileSize)
{
    public string Describe(long byteCount) => fileSize.FormatBestSize(byteCount);
}

Supported Units

Donations

If Vali-FileSize is useful to you, consider supporting its development:

• Latin America — MercadoPago
• International — PayPal

License

Apache License 2.0

Contributions

Issues and pull requests are welcome on GitHub.