Data.ByteUnits

Here is a quick example:

ByteValue (1024 * 1024 * 3) Bytes
-- the above will evaluate to: ByteValue 3145728.0 Bytes

getShortHand . getAppropriateUnits $ ByteValue (1024 * 1024 * 3) Bytes
-- the above will evaluate to: "3.00 MB"

Documentation

data ByteUnit

Constructors

Bytes

KiloBytes

MegaBytes

GigaBytes

TeraBytes

PetaBytes

ExaBytes

Instances

Eq ByteUnit

Defined in Data.ByteUnits

Methods

(==) :: ByteUnit -> ByteUnit -> Bool

(/=) :: ByteUnit -> ByteUnit -> Bool

Show ByteUnit

Defined in Data.ByteUnits

Methods

showsPrec :: Int -> ByteUnit -> ShowS

show :: ByteUnit -> String

showList :: [ByteUnit] -> ShowS

data ByteValue

Constructors

ByteValue Float ByteUnit

Instances

Eq ByteValue

Defined in Data.ByteUnits

Methods

(==) :: ByteValue -> ByteValue -> Bool

(/=) :: ByteValue -> ByteValue -> Bool

Ord ByteValue

Also allows comparing sizes, but because it uses float - it might not be 100% accurate

>>> ByteValue 1024 MegaBytes == ByteValue 1 GigaBytes
False

>>> ByteValue 1023 MegaBytes < ByteValue 1 GigaBytes
True

Defined in Data.ByteUnits

Methods

compare :: ByteValue -> ByteValue -> Ordering

(<) :: ByteValue -> ByteValue -> Bool

(<=) :: ByteValue -> ByteValue -> Bool

(>) :: ByteValue -> ByteValue -> Bool

(>=) :: ByteValue -> ByteValue -> Bool

max :: ByteValue -> ByteValue -> ByteValue

min :: ByteValue -> ByteValue -> ByteValue

Show ByteValue

Defined in Data.ByteUnits

Methods

showsPrec :: Int -> ByteValue -> ShowS

show :: ByteValue -> String

showList :: [ByteValue] -> ShowS

getBytes :: ByteValue -> Float

Gets the value of bytes from a ByteValue type

convertByteUnit :: ByteValue -> ByteUnit -> ByteValue

Converts the ByteValue to an ByteValue with the specified ByteUnit

>>> convertByteUnit (ByteValue 500 GigaBytes) MegaBytes
ByteValue 512000.0 MegaBytes

getAppropriateUnits :: ByteValue -> ByteValue

Converts to the largest unit size provided the float value is > 1

>>> getAppropriateUnits (ByteValue 1024 Bytes)
ByteValue 1 KiloBytes

>>> getAppropriateUnits (ByteValue (3.5 * 1024* 1024) Bytes)
ByteValue 3.5 MegaBytes

getShortHand :: ByteValue -> String

Converts to a short string representation

>>> getShortHand $ ByteValue 100 MegaBytes
"100.00 MB"