DataSizeUnits 2.0.0

DataSizeUnits

Convert and format data size units in .NET (bits, bytes, kilobits, kilobytes, and others).

Features

• Convert between many units of digital information, including bits, bytes, and their higher-order units (kilobits and kilobytes and the rest, up to and including exabits and exabytes)

  • 150 Mbit → 17.8 MByte

    DataSize sizeInMegabytes = new DataSize(150, Unit.Megabit).ConvertToUnit(Unit.Megabyte);
    // sizeInMegabytes.Quantity == 17.8
    

• Normalize a number of bytes to an automatically-selected unit based on its magnitude

  • 2,097,152 bytes → 2 MB

    DataSize normalized = new DataSize(2_097_152).Normalize();
    // normalized.Quantity == 2.0
    // normalized.Unit == Unit.Megabyte
    

  • 2,097,152 bytes → 16.78 mbit

    DataSize normalized = new DataSize(2_097_152).Normalize(true);
    // normalized.Quantity == 16.78
    // normalized.Unit == Unit.Megabit
    

  • The unit will be automatically selected so the value is greater than or equal to 1 of that unit, and less than 1 of the next largest unit. For example, 2,097,152 bytes is greater than or equal to 1 MB and less than 1 GB, so it is normalized to MB.

• Parse unit names and abbreviations

  • Megabyte, MByte, mebibyte, MiB, MB, and M are all megabytes

    Unit unit = DataSize.ParseUnit("mib");
    // unit == Unit.Megabyte
    

  • Default abbreviations for each unit are of the short, case-sensitive forms.

    string abbreviation = Unit.Terabyte.toAbbreviation();
    // abbreviation == "TB"
    

• Format bytes as a string with different unit and precision options

  • 1,536 bytes to kilobytes, 1 digit after the decimal point → 1.5 KB

    string formatted = new DataSize(1536).ConvertToUnit(Unit.Kilobyte).ToString(1);
    // formatted == "1.5 KB"
    

    string formatted = string.Format(new DataSizeFormatter(), "Size: {0:KB1}", 1536);
    // formatted == "Size: 1.5 KB"
    

    string formatted = string.Format(new DataSizeFormatter(), "Size: {0:A1}", 1536);
    // formatted == "Size: 1.5 KB"
    

  • The format specifier (like KB1 above) is made up of two optional parts, the destination unit (KB) and the precision (1).
  • The destination unit (KB) is the data size unit to which you want the input bytes to be converted. You can pass any data size unit abbreviation. Case matters for ambiguous units, like kB/KB/K for kilobytes and kb/k/Kb for kilobits. Unambiguous units like kilobyte/kbyte/kibibyte/kib can be provided in any case. You can also specify A to automatically normalize the unit of bytes and higher magnitudes, which is the default behavior if you omit the destination unit, and a normalizes to bits.
  • The precision (1) is the number of digits after the decimal place. If you omit this, it will use the default number format value for the culture of the current thread, for example 2. Set this to 0 if you want integers only.

Install

This package is available in the NuGet Gallery.

This is a .NET Standard 2.0 library, and can be depended upon in projects with .NET Framework 4.6.1, .NET Core 2.0, or later.