Safe Haskell	None
Language	Haskell2010

Data.Bytes.Formatting.Size

Description

Provides formatters for Size.

Since: 0.1

Synopsis

data SizeFormat
- = SizeFormatShort
- | SizeFormatMedium
- | SizeFormatLong
_SizeFormatShort :: Prism' SizeFormat ()
_SizeFormatMedium :: Prism' SizeFormat ()
_SizeFormatLong :: Prism' SizeFormat ()
data SizedFormatter = MkSizedFormatter {
- caseFormat :: CaseFormat
- leadingSpace :: Bool
- sizeFormat :: SizeFormat
}
formatSize :: Sized a => SizedFormatter -> a -> Text
sizedFormatterUnix :: SizedFormatter
sizedFormatterNatural :: SizedFormatter
sizedFormatterVerbose :: SizedFormatter

Documentation

data SizeFormat Source #

Determines how to format the size units.

Examples

Expand

>>> def @SizeFormat
SizeFormatMedium

Since: 0.1

Constructors

SizeFormatShort	Since: 0.1
SizeFormatMedium	Since: 0.1
SizeFormatLong	Since: 0.1

Instances

Instances details

Show SizeFormat Source #	Since: 0.1
Instance details Defined in Data.Bytes.Formatting.Size Methods showsPrec :: Int -> SizeFormat -> ShowS # show :: SizeFormat -> String # showList :: [SizeFormat] -> ShowS #
Default SizeFormat Source #	Since: 0.1
Instance details Defined in Data.Bytes.Formatting.Size Methods def :: SizeFormat Source #
Eq SizeFormat Source #	Since: 0.1
Instance details Defined in Data.Bytes.Formatting.Size Methods (==) :: SizeFormat -> SizeFormat -> Bool # (/=) :: SizeFormat -> SizeFormat -> Bool #

_SizeFormatShort :: Prism' SizeFormat () Source #

Since: 0.1

_SizeFormatMedium :: Prism' SizeFormat () Source #

Since: 0.1

_SizeFormatLong :: Prism' SizeFormat () Source #

Since: 0.1

data SizedFormatter Source #

Formatting size units.

Examples

Expand

>>> def @SizedFormatter
MkSizedFormatter {caseFormat = CaseFormatLower, leadingSpace = True, sizeFormat = SizeFormatMedium}

Since: 0.1

Constructors

MkSizedFormatter
Fields caseFormat :: CaseFormat leadingSpace :: Bool sizeFormat :: SizeFormat

Instances

Instances details

Show SizedFormatter Source #	Since: 0.1
Instance details Defined in Data.Bytes.Formatting.Size Methods showsPrec :: Int -> SizedFormatter -> ShowS # show :: SizedFormatter -> String # showList :: [SizedFormatter] -> ShowS #
Default SizedFormatter Source #
Instance details Defined in Data.Bytes.Formatting.Size Methods def :: SizedFormatter Source #
Eq SizedFormatter Source #	Since: 0.1
Instance details Defined in Data.Bytes.Formatting.Size Methods (==) :: SizedFormatter -> SizedFormatter -> Bool # (/=) :: SizedFormatter -> SizedFormatter -> Bool #
Formatter SizedFormatter Source #	Since: 0.1
Instance details Defined in Data.Bytes.Formatting.Size Methods formatStr :: SizedFormatter -> Text Source #
(k ~ A_Lens, a ~ CaseFormat, b ~ CaseFormat) => LabelOptic "caseFormat" k SizedFormatter SizedFormatter a b Source #	Since: 0.1
Instance details Defined in Data.Bytes.Formatting.Size Methods labelOptic :: Optic k NoIx SizedFormatter SizedFormatter a b Source #
(k ~ A_Lens, a ~ Bool, b ~ Bool) => LabelOptic "leadingSpace" k SizedFormatter SizedFormatter a b Source #	Since: 0.1
Instance details Defined in Data.Bytes.Formatting.Size Methods labelOptic :: Optic k NoIx SizedFormatter SizedFormatter a b Source #
(k ~ A_Lens, a ~ SizeFormat, b ~ SizeFormat) => LabelOptic "sizeFormat" k SizedFormatter SizedFormatter a b Source #	Since: 0.1
Instance details Defined in Data.Bytes.Formatting.Size Methods labelOptic :: Optic k NoIx SizedFormatter SizedFormatter a b Source #

formatSize :: Sized a => SizedFormatter -> a -> Text Source #

Formats size units.

Since: 0.1

sizedFormatterUnix :: SizedFormatter Source #

Unix-style formatter:

Upper case.
No space between value and unit.
Single letter unit.

For example: 7G.

Since: 0.1

sizedFormatterNatural :: SizedFormatter Source #

Natural-style formatter:

Lower case.
Space between value and unit.
Two letter units.

For example: 7 gb.

Since: 0.1

sizedFormatterVerbose :: SizedFormatter Source #

Verbose formatter:

Lower case.
Space between value and unit.
Full spelling.

For example: 7 gigabytes.

Since: 0.1