Humanizer.ByteSize
ByteSize Struct
public struct ByteSize : System.IComparable<Humanizer.ByteSize>, System.IEquatable<Humanizer.ByteSize>, System.IComparable, System.IFormattable
Implements System.IComparable<ByteSize>, System.IEquatable<ByteSize>, System.IComparable, System.IFormattable
- Constructors
- Fields
- Bit
- BitsInByte
- BitSymbol
- Byte
- BytesInDecimalExabyte
- BytesInDecimalGigabyte
- BytesInDecimalKilobyte
- BytesInDecimalMegabyte
- BytesInDecimalPetabyte
- BytesInDecimalTerabyte
- BytesInExabyte
- BytesInGibibyte
- BytesInGigabyte
- BytesInKibibyte
- BytesInKilobyte
- BytesInMebibyte
- BytesInMegabyte
- BytesInPebibyte
- BytesInPetabyte
- BytesInTebibyte
- BytesInTerabyte
- ByteSymbol
- Exabyte
- ExabyteSymbol
- Gibibyte
- GibibyteSymbol
- Gigabyte
- GigabyteSymbol
- Kibibyte
- KibibyteSymbol
- Kilobyte
- KilobyteSymbol
- MaxValue
- Mebibyte
- MebibyteSymbol
- Megabyte
- MegabyteSymbol
- MinValue
- Pebibyte
- PebibyteSymbol
- Petabyte
- PetabyteSymbol
- Tebibyte
- TebibyteSymbol
- Terabyte
- TerabyteSymbol
- Properties
- Methods
- Add(ByteSize)
- AddBits(long)
- AddBytes(double)
- AddExabytes(double)
- AddGigabytes(double)
- AddKilobytes(double)
- AddMegabytes(double)
- AddPebibytes(double)
- AddPetabytes(double)
- AddTerabytes(double)
- CompareTo(ByteSize)
- CompareTo(object)
- Equals(ByteSize)
- Equals(object)
- Format(ByteSizeUnitSystem, string, IFormatProvider)
- FormatFullWords(ByteSizeUnitSystem, string, IFormatProvider)
- FromBits(long)
- FromBytes(double)
- FromDecimalExabytes(double)
- FromDecimalGigabytes(double)
- FromDecimalKilobytes(double)
- FromDecimalMegabytes(double)
- FromDecimalPetabytes(double)
- FromDecimalTerabytes(double)
- FromExabytes(double)
- FromGibibytes(double)
- FromGigabytes(double)
- FromKibibytes(double)
- FromKilobytes(double)
- FromMebibytes(double)
- FromMegabytes(double)
- FromPebibytes(double)
- FromPetabytes(double)
- FromTebibytes(double)
- FromTerabytes(double)
- GetHashCode()
- GetLargestWholeNumberFullWord(IFormatProvider)
- GetLargestWholeNumberSymbol(IFormatProvider)
- Parse(string)
- Parse(string, IFormatProvider)
- ParseWithUnitSystem(string, ByteSizeUnitSystem, IFormatProvider)
- Subtract(ByteSize)
- ToFullWords(string, IFormatProvider)
- ToString()
- ToString(string)
- ToString(string, IFormatProvider)
- ToString(IFormatProvider)
- TryParse(string, ByteSize)
- TryParse(string, IFormatProvider, ByteSize)
- TryParse(ReadOnlySpan<char>, ByteSize)
- TryParse(ReadOnlySpan<char>, IFormatProvider, ByteSize)
- TryParseSpanWithUnitSystem(ReadOnlySpan<char>, ByteSizeUnitSystem, ByteSize)
- TryParseSpanWithUnitSystem(ReadOnlySpan<char>, ByteSizeUnitSystem, IFormatProvider, ByteSize)
- TryParseWithUnitSystem(string, ByteSizeUnitSystem, ByteSize)
- TryParseWithUnitSystem(string, ByteSizeUnitSystem, IFormatProvider, ByteSize)
- Operators
- operator +(ByteSize, ByteSize)
- operator --(ByteSize)
- operator ==(ByteSize, ByteSize)
- operator >(ByteSize, ByteSize)
- operator >=(ByteSize, ByteSize)
- operator ++(ByteSize)
- operator !=(ByteSize, ByteSize)
- operator <(ByteSize, ByteSize)
- operator <=(ByteSize, ByteSize)
- operator -(ByteSize, ByteSize)
- operator -(ByteSize)
Constructors
ByteSize(double) Constructor
public ByteSize(double byteSize);
Parameters
byteSize System.Double
Fields
ByteSize.Bit Field
public const string Bit = "bit";
Field Value
ByteSize.BitsInByte Field
public const long BitsInByte = 8;
Field Value
ByteSize.BitSymbol Field
public const string BitSymbol = "b";
Field Value
ByteSize.Byte Field
public const string Byte = "byte";
Field Value
ByteSize.BytesInDecimalExabyte Field
Gets the number of bytes in one decimal SI exabyte.
public const long BytesInDecimalExabyte = 1000000000000000000;
Field Value
ByteSize.BytesInDecimalGigabyte Field
Gets the number of bytes in one decimal SI gigabyte.
public const long BytesInDecimalGigabyte = 1000000000;
Field Value
ByteSize.BytesInDecimalKilobyte Field
Gets the number of bytes in one decimal SI kilobyte.
public const long BytesInDecimalKilobyte = 1000;
Field Value
ByteSize.BytesInDecimalMegabyte Field
Gets the number of bytes in one decimal SI megabyte.
public const long BytesInDecimalMegabyte = 1000000;
Field Value
ByteSize.BytesInDecimalPetabyte Field
Gets the number of bytes in one decimal SI petabyte.
public const long BytesInDecimalPetabyte = 1000000000000000;
Field Value
ByteSize.BytesInDecimalTerabyte Field
Gets the number of bytes in one decimal SI terabyte.
public const long BytesInDecimalTerabyte = 1000000000000;
Field Value
ByteSize.BytesInExabyte Field
public const long BytesInExabyte = 1000000000000000000;
Field Value
ByteSize.BytesInGibibyte Field
The number of bytes in a gibibyte, equivalent to the established gigabyte factor.
public const long BytesInGibibyte = 1073741824;
Field Value
ByteSize.BytesInGigabyte Field
public const long BytesInGigabyte = 1073741824;
Field Value
ByteSize.BytesInKibibyte Field
The number of bytes in a kibibyte, equivalent to the established kilobyte factor.
public const long BytesInKibibyte = 1024;
Field Value
ByteSize.BytesInKilobyte Field
public const long BytesInKilobyte = 1024;
Field Value
ByteSize.BytesInMebibyte Field
The number of bytes in a mebibyte, equivalent to the established megabyte factor.
public const long BytesInMebibyte = 1048576;
Field Value
ByteSize.BytesInMegabyte Field
public const long BytesInMegabyte = 1048576;
Field Value
ByteSize.BytesInPebibyte Field
public const long BytesInPebibyte = 1125899906842624;
Field Value
ByteSize.BytesInPetabyte Field
public const long BytesInPetabyte = 1000000000000000;
Field Value
ByteSize.BytesInTebibyte Field
The number of bytes in a tebibyte, equivalent to the established terabyte factor.
public const long BytesInTebibyte = 1099511627776;
Field Value
ByteSize.BytesInTerabyte Field
public const long BytesInTerabyte = 1099511627776;
Field Value
ByteSize.ByteSymbol Field
public const string ByteSymbol = "B";
Field Value
ByteSize.Exabyte Field
public const string Exabyte = "exabyte";
Field Value
ByteSize.ExabyteSymbol Field
public const string ExabyteSymbol = "EB";
Field Value
ByteSize.Gibibyte Field
The name of a gibibyte.
public const string Gibibyte = "gibibyte";
Field Value
ByteSize.GibibyteSymbol Field
The symbol for a gibibyte.
public const string GibibyteSymbol = "GiB";
Field Value
ByteSize.Gigabyte Field
public const string Gigabyte = "gigabyte";
Field Value
ByteSize.GigabyteSymbol Field
public const string GigabyteSymbol = "GB";
Field Value
ByteSize.Kibibyte Field
The name of a kibibyte.
public const string Kibibyte = "kibibyte";
Field Value
ByteSize.KibibyteSymbol Field
The symbol for a kibibyte.
public const string KibibyteSymbol = "KiB";
Field Value
ByteSize.Kilobyte Field
public const string Kilobyte = "kilobyte";
Field Value
ByteSize.KilobyteSymbol Field
public const string KilobyteSymbol = "KB";
Field Value
ByteSize.MaxValue Field
public static readonly ByteSize MaxValue;
Field Value
ByteSize.Mebibyte Field
The name of a mebibyte.
public const string Mebibyte = "mebibyte";
Field Value
ByteSize.MebibyteSymbol Field
The symbol for a mebibyte.
public const string MebibyteSymbol = "MiB";
Field Value
ByteSize.Megabyte Field
public const string Megabyte = "megabyte";
Field Value
ByteSize.MegabyteSymbol Field
public const string MegabyteSymbol = "MB";
Field Value
ByteSize.MinValue Field
public static readonly ByteSize MinValue;
Field Value
ByteSize.Pebibyte Field
public const string Pebibyte = "pebibyte";
Field Value
ByteSize.PebibyteSymbol Field
public const string PebibyteSymbol = "PiB";
Field Value
ByteSize.Petabyte Field
public const string Petabyte = "petabyte";
Field Value
ByteSize.PetabyteSymbol Field
public const string PetabyteSymbol = "PB";
Field Value
ByteSize.Tebibyte Field
The name of a tebibyte.
public const string Tebibyte = "tebibyte";
Field Value
ByteSize.TebibyteSymbol Field
The symbol for a tebibyte.
public const string TebibyteSymbol = "TiB";
Field Value
ByteSize.Terabyte Field
public const string Terabyte = "terabyte";
Field Value
ByteSize.TerabyteSymbol Field
public const string TerabyteSymbol = "TB";
Field Value
Properties
ByteSize.Bits Property
public readonly long Bits { get; }
Property Value
ByteSize.Bytes Property
public readonly double Bytes { get; }
Property Value
ByteSize.DecimalExabytes Property
Gets this value expressed in decimal SI exabytes.
public readonly double DecimalExabytes { get; }
Property Value
ByteSize.DecimalGigabytes Property
Gets this value expressed in decimal SI gigabytes.
public readonly double DecimalGigabytes { get; }
Property Value
ByteSize.DecimalKilobytes Property
Gets this value expressed in decimal SI kilobytes.
public readonly double DecimalKilobytes { get; }
Property Value
ByteSize.DecimalMegabytes Property
Gets this value expressed in decimal SI megabytes.
public readonly double DecimalMegabytes { get; }
Property Value
ByteSize.DecimalPetabytes Property
Gets this value expressed in decimal SI petabytes.
public readonly double DecimalPetabytes { get; }
Property Value
ByteSize.DecimalTerabytes Property
Gets this value expressed in decimal SI terabytes.
public readonly double DecimalTerabytes { get; }
Property Value
ByteSize.Exabytes Property
public readonly double Exabytes { get; }
Property Value
ByteSize.Gibibytes Property
Gets the size in gibibytes.
public readonly double Gibibytes { get; }
Property Value
ByteSize.Gigabytes Property
public readonly double Gigabytes { get; }
Property Value
ByteSize.Kibibytes Property
Gets the size in kibibytes.
public readonly double Kibibytes { get; }
Property Value
ByteSize.Kilobytes Property
public readonly double Kilobytes { get; }
Property Value
ByteSize.LargestWholeNumberFullWord Property
public readonly string LargestWholeNumberFullWord { get; }
Property Value
ByteSize.LargestWholeNumberSymbol Property
public readonly string LargestWholeNumberSymbol { get; }
Property Value
ByteSize.LargestWholeNumberValue Property
public readonly double LargestWholeNumberValue { get; }
Property Value
ByteSize.Mebibytes Property
Gets the size in mebibytes.
public readonly double Mebibytes { get; }
Property Value
ByteSize.Megabytes Property
public readonly double Megabytes { get; }
Property Value
ByteSize.Pebibytes Property
public readonly double Pebibytes { get; }
Property Value
ByteSize.Petabytes Property
public readonly double Petabytes { get; }
Property Value
ByteSize.Tebibytes Property
Gets the size in tebibytes.
public readonly double Tebibytes { get; }
Property Value
ByteSize.Terabytes Property
public readonly double Terabytes { get; }
Property Value
Methods
ByteSize.Add(ByteSize) Method
public readonly Humanizer.ByteSize Add(Humanizer.ByteSize bs);
Parameters
bs ByteSize
Returns
ByteSize.AddBits(long) Method
public readonly Humanizer.ByteSize AddBits(long value);
Parameters
value System.Int64
Returns
ByteSize.AddBytes(double) Method
public readonly Humanizer.ByteSize AddBytes(double value);
Parameters
value System.Double
Returns
ByteSize.AddExabytes(double) Method
public readonly Humanizer.ByteSize AddExabytes(double value);
Parameters
value System.Double
Returns
ByteSize.AddGigabytes(double) Method
public readonly Humanizer.ByteSize AddGigabytes(double value);
Parameters
value System.Double
Returns
ByteSize.AddKilobytes(double) Method
public readonly Humanizer.ByteSize AddKilobytes(double value);
Parameters
value System.Double
Returns
ByteSize.AddMegabytes(double) Method
public readonly Humanizer.ByteSize AddMegabytes(double value);
Parameters
value System.Double
Returns
ByteSize.AddPebibytes(double) Method
public readonly Humanizer.ByteSize AddPebibytes(double value);
Parameters
value System.Double
Returns
ByteSize.AddPetabytes(double) Method
public readonly Humanizer.ByteSize AddPetabytes(double value);
Parameters
value System.Double
Returns
ByteSize.AddTerabytes(double) Method
public readonly Humanizer.ByteSize AddTerabytes(double value);
Parameters
value System.Double
Returns
ByteSize.CompareTo(ByteSize) Method
public readonly int CompareTo(Humanizer.ByteSize other);
Parameters
other ByteSize
Returns
ByteSize.CompareTo(object) Method
public readonly int CompareTo(object? obj);
Parameters
obj System.Object
Implements CompareTo(object)
Returns
ByteSize.Equals(ByteSize) Method
public readonly bool Equals(Humanizer.ByteSize value);
Parameters
value ByteSize
Returns
ByteSize.Equals(object) Method
public override readonly bool Equals(object? value);
Parameters
value System.Object
Returns
ByteSize.Format(ByteSizeUnitSystem, string, IFormatProvider) Method
Formats this value with an explicitly selected unit system.
public readonly string Format(Humanizer.ByteSizeUnitSystem unitSystem, string? format=null, System.IFormatProvider? formatProvider=null);
Parameters
unitSystem ByteSizeUnitSystem
The unit system to use.
format System.String
The numeric format and optional unit token. For DecimalSi and
BinaryIec, SI/IEC-prefixed unit tokens are matched case-insensitively,
while b and B remain case-sensitive; output uses canonical symbol casing.
Legacy preserves established matching behavior. At most one distinct
unescaped, unquoted unit token is permitted, although the same token may be repeated across numeric format
sections.
formatProvider System.IFormatProvider
The provider used to format the numeric value.
Returns
System.String
The formatted byte size.
Exceptions
System.ArgumentOutOfRangeException
unitSystem is not defined.
System.FormatException
format is invalid, contains mixed unit tokens, or selects a token not supported by the
selected non-legacy system.
ByteSize.FormatFullWords(ByteSizeUnitSystem, string, IFormatProvider) Method
Formats this value with localized unit words from an explicitly selected unit system.
public readonly string FormatFullWords(Humanizer.ByteSizeUnitSystem unitSystem, string? format=null, System.IFormatProvider? formatProvider=null);
Parameters
unitSystem ByteSizeUnitSystem
The unit system to use.
format System.String
The numeric format and optional unit token. For DecimalSi and
BinaryIec, SI/IEC-prefixed unit tokens are matched case-insensitively,
while b and B remain case-sensitive; localized words replace the selected token.
Legacy preserves established matching behavior. At most one distinct
unescaped, unquoted unit token is permitted, although the same token may be repeated across numeric format
sections.
formatProvider System.IFormatProvider
The provider used to format the numeric value and select localized unit words.
Returns
System.String
The formatted byte size using localized unit words.
Exceptions
System.ArgumentOutOfRangeException
unitSystem is not defined.
System.FormatException
format is invalid, contains mixed unit tokens, or selects a token not supported by the
selected non-legacy system.
ByteSize.FromBits(long) Method
public static Humanizer.ByteSize FromBits(long value);
Parameters
value System.Int64
Returns
ByteSize.FromBytes(double) Method
public static Humanizer.ByteSize FromBytes(double value);
Parameters
value System.Double
Returns
ByteSize.FromDecimalExabytes(double) Method
Creates a byte size from a number of decimal SI exabytes.
public static Humanizer.ByteSize FromDecimalExabytes(double value);
Parameters
value System.Double
The number of decimal SI exabytes.
Returns
ByteSize
The equivalent byte size.
Exceptions
System.ArgumentOutOfRangeException
value is not finite or is outside the range supported by Bits.
ByteSize.FromDecimalGigabytes(double) Method
Creates a byte size from a number of decimal SI gigabytes.
public static Humanizer.ByteSize FromDecimalGigabytes(double value);
Parameters
value System.Double
The number of decimal SI gigabytes.
Returns
ByteSize
The equivalent byte size.
Exceptions
System.ArgumentOutOfRangeException
value is not finite or is outside the range supported by Bits.
ByteSize.FromDecimalKilobytes(double) Method
Creates a byte size from a number of decimal SI kilobytes.
public static Humanizer.ByteSize FromDecimalKilobytes(double value);
Parameters
value System.Double
The number of decimal SI kilobytes.
Returns
ByteSize
The equivalent byte size.
Exceptions
System.ArgumentOutOfRangeException
value is not finite or is outside the range supported by Bits.
ByteSize.FromDecimalMegabytes(double) Method
Creates a byte size from a number of decimal SI megabytes.
public static Humanizer.ByteSize FromDecimalMegabytes(double value);
Parameters
value System.Double
The number of decimal SI megabytes.
Returns
ByteSize
The equivalent byte size.
Exceptions
System.ArgumentOutOfRangeException
value is not finite or is outside the range supported by Bits.
ByteSize.FromDecimalPetabytes(double) Method
Creates a byte size from a number of decimal SI petabytes.
public static Humanizer.ByteSize FromDecimalPetabytes(double value);
Parameters
value System.Double
The number of decimal SI petabytes.
Returns
ByteSize
The equivalent byte size.
Exceptions
System.ArgumentOutOfRangeException
value is not finite or is outside the range supported by Bits.
ByteSize.FromDecimalTerabytes(double) Method
Creates a byte size from a number of decimal SI terabytes.
public static Humanizer.ByteSize FromDecimalTerabytes(double value);
Parameters
value System.Double
The number of decimal SI terabytes.
Returns
ByteSize
The equivalent byte size.
Exceptions
System.ArgumentOutOfRangeException
value is not finite or is outside the range supported by Bits.
ByteSize.FromExabytes(double) Method
public static Humanizer.ByteSize FromExabytes(double value);
Parameters
value System.Double
Returns
ByteSize.FromGibibytes(double) Method
Creates a byte size from a number of gibibytes.
public static Humanizer.ByteSize FromGibibytes(double value);
Parameters
value System.Double
Returns
ByteSize.FromGigabytes(double) Method
public static Humanizer.ByteSize FromGigabytes(double value);
Parameters
value System.Double
Returns
ByteSize.FromKibibytes(double) Method
Creates a byte size from a number of kibibytes.
public static Humanizer.ByteSize FromKibibytes(double value);
Parameters
value System.Double
Returns
ByteSize.FromKilobytes(double) Method
public static Humanizer.ByteSize FromKilobytes(double value);
Parameters
value System.Double
Returns
ByteSize.FromMebibytes(double) Method
Creates a byte size from a number of mebibytes.
public static Humanizer.ByteSize FromMebibytes(double value);
Parameters
value System.Double
Returns
ByteSize.FromMegabytes(double) Method
public static Humanizer.ByteSize FromMegabytes(double value);
Parameters
value System.Double
Returns
ByteSize.FromPebibytes(double) Method
public static Humanizer.ByteSize FromPebibytes(double value);
Parameters
value System.Double
Returns
ByteSize.FromPetabytes(double) Method
public static Humanizer.ByteSize FromPetabytes(double value);
Parameters
value System.Double
Returns
ByteSize.FromTebibytes(double) Method
Creates a byte size from a number of tebibytes.
public static Humanizer.ByteSize FromTebibytes(double value);
Parameters
value System.Double
Returns
ByteSize.FromTerabytes(double) Method
public static Humanizer.ByteSize FromTerabytes(double value);
Parameters
value System.Double
Returns
ByteSize.GetHashCode() Method
public override readonly int GetHashCode();
Returns
ByteSize.GetLargestWholeNumberFullWord(IFormatProvider) Method
public readonly string GetLargestWholeNumberFullWord(System.IFormatProvider? provider=null);
Parameters
provider System.IFormatProvider
Returns
ByteSize.GetLargestWholeNumberSymbol(IFormatProvider) Method
public readonly string GetLargestWholeNumberSymbol(System.IFormatProvider? provider=null);
Parameters
provider System.IFormatProvider
Returns
ByteSize.Parse(string) Method
public static Humanizer.ByteSize Parse(string s);
Parameters
Returns
ByteSize.Parse(string, IFormatProvider) Method
public static Humanizer.ByteSize Parse(string s, System.IFormatProvider? formatProvider);
Parameters
formatProvider System.IFormatProvider
Returns
ByteSize.ParseWithUnitSystem(string, ByteSizeUnitSystem, IFormatProvider) Method
Parses a byte size using only the tokens defined by the selected unit system.
public static Humanizer.ByteSize ParseWithUnitSystem(string s, Humanizer.ByteSizeUnitSystem unitSystem, System.IFormatProvider? formatProvider=null);
Parameters
The text to parse.
unitSystem ByteSizeUnitSystem
The unit system whose tokens are accepted.
formatProvider System.IFormatProvider
The provider used to parse the numeric value.
Returns
ByteSize
The parsed byte size.
Exceptions
System.ArgumentNullException
s is null.
System.ArgumentOutOfRangeException
unitSystem is not defined.
System.FormatException
s is not valid for the selected unit system.
Remarks
For DecimalSi and BinaryIec, SI/IEC-prefixed
unit tokens are matched case-insensitively, while b and B remain case-sensitive.
Legacy parsing preserves the established behavior.
ByteSize.Subtract(ByteSize) Method
public readonly Humanizer.ByteSize Subtract(Humanizer.ByteSize bs);
Parameters
bs ByteSize
Returns
ByteSize.ToFullWords(string, IFormatProvider) Method
Converts the value of the current ByteSize object to a string with full words. The metric prefix symbol (bit, byte, kilo, mega, giga, tera, peta, exa) used is the largest metric prefix such that the corresponding value is greater than or equal to one.
public readonly string ToFullWords(string? format=null, System.IFormatProvider? provider=null);
Parameters
format System.String
provider System.IFormatProvider
Returns
ByteSize.ToString() Method
Converts the value of the current ByteSize object to a string. The metric prefix symbol (bit, byte, kilo, mega, giga, tera, peta, exa) used is the largest metric prefix such that the corresponding value is greater than or equal to one.
public override readonly string ToString();
Returns
ByteSize.ToString(string) Method
public readonly string ToString(string? format);
Parameters
format System.String
Returns
ByteSize.ToString(string, IFormatProvider) Method
public readonly string ToString(string? format, System.IFormatProvider? provider);
Parameters
format System.String
provider System.IFormatProvider
Implements ToString(string, IFormatProvider)
Returns
ByteSize.ToString(IFormatProvider) Method
public readonly string ToString(System.IFormatProvider? provider);
Parameters
provider System.IFormatProvider
Returns
ByteSize.TryParse(string, ByteSize) Method
public static bool TryParse(string? s, out Humanizer.ByteSize result);
Parameters
result ByteSize
Returns
ByteSize.TryParse(string, IFormatProvider, ByteSize) Method
public static bool TryParse(string? s, System.IFormatProvider? formatProvider, out Humanizer.ByteSize result);
Parameters
formatProvider System.IFormatProvider
result ByteSize
Returns
ByteSize.TryParse(ReadOnlySpan<char>, ByteSize) Method
public static bool TryParse(System.ReadOnlySpan<char> s, out Humanizer.ByteSize result);
Parameters
s System.ReadOnlySpan<System.Char>
result ByteSize
Returns
ByteSize.TryParse(ReadOnlySpan<char>, IFormatProvider, ByteSize) Method
public static bool TryParse(System.ReadOnlySpan<char> s, System.IFormatProvider? formatProvider, out Humanizer.ByteSize result);
Parameters
s System.ReadOnlySpan<System.Char>
formatProvider System.IFormatProvider
result ByteSize
Returns
ByteSize.TryParseSpanWithUnitSystem(ReadOnlySpan<char>, ByteSizeUnitSystem, ByteSize) Method
Attempts to parse a byte-size character span using only the tokens defined by the selected unit system.
public static bool TryParseSpanWithUnitSystem(System.ReadOnlySpan<char> s, Humanizer.ByteSizeUnitSystem unitSystem, out Humanizer.ByteSize result);
Parameters
s System.ReadOnlySpan<System.Char>
The character span to parse.
unitSystem ByteSizeUnitSystem
The unit system whose tokens are accepted.
result ByteSize
When this method returns, contains the parsed byte size if parsing succeeded; otherwise, the default value.
Returns
System.Boolean
true if parsing succeeded; otherwise, false.
Exceptions
System.ArgumentOutOfRangeException
unitSystem is not defined.
Remarks
For DecimalSi and BinaryIec, SI/IEC-prefixed
unit tokens are matched case-insensitively, while b and B remain case-sensitive.
Legacy parsing preserves the established behavior.
ByteSize.TryParseSpanWithUnitSystem(ReadOnlySpan<char>, ByteSizeUnitSystem, IFormatProvider, ByteSize) Method
Attempts to parse a byte-size character span using only the tokens defined by the selected unit system.
public static bool TryParseSpanWithUnitSystem(System.ReadOnlySpan<char> s, Humanizer.ByteSizeUnitSystem unitSystem, System.IFormatProvider? formatProvider, out Humanizer.ByteSize result);
Parameters
s System.ReadOnlySpan<System.Char>
The character span to parse.
unitSystem ByteSizeUnitSystem
The unit system whose tokens are accepted.
formatProvider System.IFormatProvider
The provider used to parse the numeric value.
result ByteSize
When this method returns, contains the parsed byte size if parsing succeeded; otherwise, the default value.
Returns
System.Boolean
true if parsing succeeded; otherwise, false.
Exceptions
System.ArgumentOutOfRangeException
unitSystem is not defined.
Remarks
For DecimalSi and BinaryIec, SI/IEC-prefixed
unit tokens are matched case-insensitively, while b and B remain case-sensitive.
Legacy parsing preserves the established behavior.
ByteSize.TryParseWithUnitSystem(string, ByteSizeUnitSystem, ByteSize) Method
Attempts to parse a byte size using only the tokens defined by the selected unit system.
public static bool TryParseWithUnitSystem(string? s, Humanizer.ByteSizeUnitSystem unitSystem, out Humanizer.ByteSize result);
Parameters
The text to parse.
unitSystem ByteSizeUnitSystem
The unit system whose tokens are accepted.
result ByteSize
When this method returns, contains the parsed byte size if parsing succeeded; otherwise, the default value.
Returns
System.Boolean
true if parsing succeeded; otherwise, false.
Exceptions
System.ArgumentOutOfRangeException
unitSystem is not defined.
Remarks
For DecimalSi and BinaryIec, SI/IEC-prefixed
unit tokens are matched case-insensitively, while b and B remain case-sensitive.
Legacy parsing preserves the established behavior.
ByteSize.TryParseWithUnitSystem(string, ByteSizeUnitSystem, IFormatProvider, ByteSize) Method
Attempts to parse a byte size using only the tokens defined by the selected unit system.
public static bool TryParseWithUnitSystem(string? s, Humanizer.ByteSizeUnitSystem unitSystem, System.IFormatProvider? formatProvider, out Humanizer.ByteSize result);
Parameters
The text to parse.
unitSystem ByteSizeUnitSystem
The unit system whose tokens are accepted.
formatProvider System.IFormatProvider
The provider used to parse the numeric value.
result ByteSize
When this method returns, contains the parsed byte size if parsing succeeded; otherwise, the default value.
Returns
System.Boolean
true if parsing succeeded; otherwise, false.
Exceptions
System.ArgumentOutOfRangeException
unitSystem is not defined.
Remarks
For DecimalSi and BinaryIec, SI/IEC-prefixed
unit tokens are matched case-insensitively, while b and B remain case-sensitive.
Legacy parsing preserves the established behavior.
Operators
ByteSize.operator +(ByteSize, ByteSize) Operator
public static Humanizer.ByteSize operator +(Humanizer.ByteSize b1, Humanizer.ByteSize b2);
Parameters
b1 ByteSize
b2 ByteSize
Returns
ByteSize.operator --(ByteSize) Operator
public static Humanizer.ByteSize operator --(Humanizer.ByteSize b);
Parameters
b ByteSize
Returns
ByteSize.operator ==(ByteSize, ByteSize) Operator
public static bool operator ==(Humanizer.ByteSize b1, Humanizer.ByteSize b2);
Parameters
b1 ByteSize
b2 ByteSize
Returns
ByteSize.operator >(ByteSize, ByteSize) Operator
public static bool operator >(Humanizer.ByteSize b1, Humanizer.ByteSize b2);
Parameters
b1 ByteSize
b2 ByteSize
Returns
ByteSize.operator >=(ByteSize, ByteSize) Operator
public static bool operator >=(Humanizer.ByteSize b1, Humanizer.ByteSize b2);
Parameters
b1 ByteSize
b2 ByteSize
Returns
ByteSize.operator ++(ByteSize) Operator
public static Humanizer.ByteSize operator ++(Humanizer.ByteSize b);
Parameters
b ByteSize
Returns
ByteSize.operator !=(ByteSize, ByteSize) Operator
public static bool operator !=(Humanizer.ByteSize b1, Humanizer.ByteSize b2);
Parameters
b1 ByteSize
b2 ByteSize
Returns
ByteSize.operator <(ByteSize, ByteSize) Operator
public static bool operator <(Humanizer.ByteSize b1, Humanizer.ByteSize b2);
Parameters
b1 ByteSize
b2 ByteSize
Returns
ByteSize.operator <=(ByteSize, ByteSize) Operator
public static bool operator <=(Humanizer.ByteSize b1, Humanizer.ByteSize b2);
Parameters
b1 ByteSize
b2 ByteSize
Returns
ByteSize.operator -(ByteSize, ByteSize) Operator
public static Humanizer.ByteSize operator -(Humanizer.ByteSize b1, Humanizer.ByteSize b2);
Parameters
b1 ByteSize
b2 ByteSize
Returns
ByteSize.operator -(ByteSize) Operator
public static Humanizer.ByteSize operator -(Humanizer.ByteSize b);
Parameters
b ByteSize