Safe Haskell	Safe
Language	Haskell2010

Data.ByteUnits

Description

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"

Synopsis

Documentation

Constructors

Instances

Eq ByteUnit Source #
Instance details Defined in Data.ByteUnits Methods (==) :: ByteUnit -> ByteUnit -> Bool # (/=) :: ByteUnit -> ByteUnit -> Bool #
Show ByteUnit Source #
Instance details Defined in Data.ByteUnits Methods showsPrec :: Int -> ByteUnit -> ShowS # show :: ByteUnit -> String # showList :: [ByteUnit] -> ShowS #

Constructors

Instances

Eq ByteValue Source #
Instance details Defined in Data.ByteUnits Methods (==) :: ByteValue -> ByteValue -> Bool # (/=) :: ByteValue -> ByteValue -> Bool #
Ord ByteValue Source #	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
Instance details 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 Source #
Instance details Defined in Data.ByteUnits Methods showsPrec :: Int -> ByteValue -> ShowS # show :: ByteValue -> String # showList :: [ByteValue] -> ShowS #

Gets the value of bytes from a ByteValue type

Converts the ByteValue to an ByteValue with the specified ByteUnit

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

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

Converts to a short string representation

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