Class ByteUnits

Converts a size string with optional units into a count.

K or KB	1,000
Ki or kiB	1,024
M or MB	1000000
Mi or MiB	1,048,576
G or GB	1,000,000,000
Gi or GiB	1,073,741,824
T or TB	1,000,000,000,000
Ti or TiB	1,099,511,627,776
P or PB	1,000,000,000,000,000
Pi or PiB	1,125,899,906,842,624
E or EB	1,000,000,000,000,000,000‬
Ei or EiB	1,152,921,504,606,846,976‬

Inheritance

object

ByteUnits

Namespace: Neon.Common

Assembly: Neon.Common.dll

Syntax

public static class ByteUnits

Fields

ExaBytes

One PB: 1,000,000,000,000,000

Declaration

public const decimal ExaBytes = 1000000000000000000

Field Value

Type	Description
decimal

ExbiBytes

One PiB: 1,152,921,504,606,846,976‬ (2^60)

Declaration

public const decimal ExbiBytes = 1152921504606846976

Field Value

Type	Description
decimal

GibiBytes

One GiB: 1,073,741,824 (2^30)

Declaration

public const decimal GibiBytes = 1073741824

Field Value

Type	Description
decimal

GigaBytes

One GB: 1,000,000,000

Declaration

public const decimal GigaBytes = 1000000000

Field Value

Type	Description
decimal

KibiBytes

One KiB: 1,024 (2^10)

Declaration

public const decimal KibiBytes = 1024

Field Value

Type	Description
decimal

KiloBytes

One KB: 1,000

Declaration

public const decimal KiloBytes = 1000

Field Value

Type	Description
decimal

MebiBytes

One MiB: 1,048,576 (2^20)

Declaration

public const decimal MebiBytes = 1048576

Field Value

Type	Description
decimal

MegaBytes

One MB: 1,000,000

Declaration

public const decimal MegaBytes = 1000000

Field Value

Type	Description
decimal

PebiBytes

One PiB: 1,125,899,906,842,624 (2^50)

Declaration

public const decimal PebiBytes = 1125899906842624

Field Value

Type	Description
decimal

PetaBytes

One PB: 1,000,000,000,000

Declaration

public const decimal PetaBytes = 1000000000000000

Field Value

Type	Description
decimal

TebiBytes

The constant 1,099,511,627,776 (2^40)

Declaration

public const decimal TebiBytes = 1099511627776

Field Value

Type	Description
decimal

TeraBytes

The constant 1,000,000,000

Declaration

public const decimal TeraBytes = 1000000000000

Field Value

Type	Description
decimal

Methods

Humanize(decimal, bool, bool, bool)

Humanizes the size passed into a string using appropriate units. This uses power-of-10 based units by default but you can switch to power-of-2 units by passing powerOfTwo as true.

Declaration

public static string Humanize(decimal size, bool powerOfTwo = false, bool spaceBeforeUnit = true, bool removeByteUnit = false)

Parameters

Type	Name	Description
decimal	size	The size.
bool	powerOfTwo	Optionally returns a power-of-2 based unit.
bool	spaceBeforeUnit	Optionally excludes a space between the value and unit (this defaults to true.
bool	removeByteUnit	Optionally strip any trailing "B" from the unit string. For example when this is set, a decimal value of 1000 will return 1K instead of 1KB.

Returns

Type	Description
string	The converted string.

Parse(string)

Parses a size and returns a decimal.

Declaration

public static decimal Parse(string text)

Parameters

Type	Name	Description
string	text	The value being parsed.

Returns

Type	Description
decimal	The parsed value.

Exceptions

Type	Condition
FormatException	Thrown if the value cannot be parsed.

ToByteString(decimal)

Converts a size to a string using byte units.

Declaration

public static string ToByteString(decimal size)

Parameters

Type	Name	Description
decimal	size	The size.

Returns

Type	Description
string	The size in bytes.

ToEB(decimal)

Converts a size to a string using EB units.

Declaration

public static string ToEB(decimal size)

Parameters

Type	Name	Description
decimal	size	The size.

Returns

Type	Description
string	The size in EB.

ToEiB(decimal)

Converts a size to a string using EiB units.

Declaration

public static string ToEiB(decimal size)

Parameters

Type	Name	Description
decimal	size	The size.

Returns

Type	Description
string	The size in EiB.

ToGB(decimal)

Converts a size to a string using GB units.

Declaration

public static string ToGB(decimal size)

Parameters

Type	Name	Description
decimal	size	The size.

Returns

Type	Description
string	The size in GB.

ToGiB(decimal)

Converts a size to a string using GiB units.

Declaration

public static string ToGiB(decimal size)

Parameters

Type	Name	Description
decimal	size	The size.

Returns

Type	Description
string	The size in GiB.

ToKB(decimal)

Converts a size to a string using KB units.

Declaration

public static string ToKB(decimal size)

Parameters

Type	Name	Description
decimal	size	The size.

Returns

Type	Description
string	The size in KB.

ToKiB(decimal)

Converts a size to a string using KiB units.

Declaration

public static string ToKiB(decimal size)

Parameters

Type	Name	Description
decimal	size	The size.

Returns

Type	Description
string	The size in KiB.

ToMB(decimal)

Converts a size to a string using MB units.

Declaration

public static string ToMB(decimal size)

Parameters

Type	Name	Description
decimal	size	The size.

Returns

Type	Description
string	The size in MB.

ToMiB(decimal)

Converts a size to a string using MiB units.

Declaration

public static string ToMiB(decimal size)

Parameters

Type	Name	Description
decimal	size	The size.

Returns

Type	Description
string	The size in MiB.

ToPB(decimal)

Converts a size to a string using PB units.

Declaration

public static string ToPB(decimal size)

Parameters

Type	Name	Description
decimal	size	The size.

Returns

Type	Description
string	The size in PB.

ToPiB(decimal)

Converts a size to a string using PiB units.

Declaration

public static string ToPiB(decimal size)

Parameters

Type	Name	Description
decimal	size	The size.

Returns

Type	Description
string	The size in PiB.

ToTB(decimal)

Converts a size to a string using TB units.

Declaration

public static string ToTB(decimal size)

Parameters

Type	Name	Description
decimal	size	The size.

Returns

Type	Description
string	The size in TB.

ToTiB(decimal)

Converts a size to a string using TiB units.

Declaration

public static string ToTiB(decimal size)

Parameters

Type	Name	Description
decimal	size	The size.

Returns

Type	Description
string	The size in TiB.

TryParse(string, out decimal)

Parses a floating point count string that may include one of the optional unit suffixes described here ByteUnits.

Declaration

public static bool TryParse(string input, out decimal value)

Parameters

Type	Name	Description
string	input	The input string.
decimal	value	Returns as the output value.

Returns

Type	Description
bool	true on success