Safe Haskell	None
Language	Haskell2010

Data.Bytes.Network

Contents

Introduction
Basic Usage
Transformations
- Converting Units
- Normalization
Algebra
Text
- Pretty Printing
- Parsing
Optics
Reexports

Description

This module serves as an alternative entry point to Data.Bytes, for when tracking uploaded vs. downloaded bytes is necessary. It provides the types and operations for typical usage and is usually the only import required. The core concept is:

Wrapping a numeric value representing bytes in a new type.
Attaching phantom labels representing the units (e.g. B, K, M, ...).
Attaching phantom labels representing the direction (i.e. Down, Up).

This prevents mistakes, such as adding two different byte sizes/directions, or converting between sizes incorrectly.

Since: 0.1

Synopsis

newtype NetBytes (d :: Direction) (s :: Size) n where
- MkNetBytes (Bytes s n)
- pattern MkNetBytesP :: forall d s n. n -> NetBytes d s n
data Size
- = B
- | K
- | M
- | G
- | T
- | P
- | E
- | Z
- | Y
data Direction
- = Down
- | Up
data SomeNetSize (d :: Direction) n
class Sized a where
- type HideSize a
- sizeOf :: a -> Size
- hideSize :: a -> HideSize a
data SomeNetDir (s :: Size) n
data SomeNet n
class Directed a where
- type HideDirection a
- directionOf :: a -> Direction
- hideDirection :: a -> HideDirection a
class RawNumeric a where
- type Raw a
- toRaw :: a -> Raw a
class Conversion a where
- type Converted (t :: Size) a = (r :: Type) | r -> t
- convert_ :: forall (t :: Size). SingI t => a -> Converted t a
class Normalize a where
- type Norm a
- normalize :: a -> Norm a
module Numeric.Algebra
module Numeric.Convert.Integer
module Numeric.Convert.Rational
module Numeric.Convert.Real
module Data.Bytes.Formatting
class Parser a
parse :: Parser a => Text -> Either Text a
_MkNetBytes :: forall (s :: Size) (d :: Direction) n. Iso' (NetBytes d s n) (Bytes s n)
_MkSomeNetSize :: forall (s :: Size) (d :: Direction) n. (FromInteger n, MGroup n, SingI s) => Iso' (SomeNetSize d n) (NetBytes d s n)
_MkSomeNetDir :: forall (s :: Size) (d :: Direction) n. SingI d => Review (SomeNetDir s n) (NetBytes d s n)
_MkSomeNet :: forall (s :: Size) (d :: Direction) n. (SingI d, SingI s) => Review (SomeNet n) (NetBytes d s n)
_B :: Prism' Size ()
_K :: Prism' Size ()
_M :: Prism' Size ()
_G :: Prism' Size ()
_T :: Prism' Size ()
_P :: Prism' Size ()
_E :: Prism' Size ()
_Z :: Prism' Size ()
_Y :: Prism' Size ()
_Down :: Prism' Direction ()
_Up :: Prism' Direction ()
class Default a where
- def :: a

Introduction

The main idea is to attach phantom labels to the numeric bytes, so we can track the size and direction units. This allows us to safely manipulate byte values without mixing up units, performing incorrect conversions, etc.

The core types are a newtype wrapper NetBytes, the Size units, and the Direction units:

newtype NetBytes (d :: Direction) (s :: Size) n Source #

Wrapper around the Bytes type that adds the Direction tag.

Examples

Expand

>>> MkNetBytesP @Up @M 1000
MkNetBytes (MkBytes 1000)

Since: 0.1

Constructors

MkNetBytes (Bytes s n)

Bundled Patterns

pattern MkNetBytesP :: forall d s n. n -> NetBytes d s n

Pattern for de/constructing NetBytes.

Since: 0.1

Instances

Instances details

HasField "unNetBytes" (NetBytes d s n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

getField :: NetBytes d s n -> n #

(k ~ An_Iso, a ~ n, b ~ n) => LabelOptic "unNetBytes" k (NetBytes d s n) (NetBytes d s n) a b Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

labelOptic :: Optic k NoIx (NetBytes d s n) (NetBytes d s n) a b Source #

Foldable (NetBytes d s) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

fold :: Monoid m => NetBytes d s m -> m #

foldMap :: Monoid m => (a -> m) -> NetBytes d s a -> m #

foldMap' :: Monoid m => (a -> m) -> NetBytes d s a -> m #

foldr :: (a -> b -> b) -> b -> NetBytes d s a -> b #

foldr' :: (a -> b -> b) -> b -> NetBytes d s a -> b #

foldl :: (b -> a -> b) -> b -> NetBytes d s a -> b #

foldl' :: (b -> a -> b) -> b -> NetBytes d s a -> b #

foldr1 :: (a -> a -> a) -> NetBytes d s a -> a #

foldl1 :: (a -> a -> a) -> NetBytes d s a -> a #

toList :: NetBytes d s a -> [a] #

null :: NetBytes d s a -> Bool #

length :: NetBytes d s a -> Int #

elem :: Eq a => a -> NetBytes d s a -> Bool #

maximum :: Ord a => NetBytes d s a -> a #

minimum :: Ord a => NetBytes d s a -> a #

sum :: Num a => NetBytes d s a -> a #

product :: Num a => NetBytes d s a -> a #

Traversable (NetBytes d s) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

traverse :: Applicative f => (a -> f b) -> NetBytes d s a -> f (NetBytes d s b) #

sequenceA :: Applicative f => NetBytes d s (f a) -> f (NetBytes d s a) #

mapM :: Monad m => (a -> m b) -> NetBytes d s a -> m (NetBytes d s b) #

sequence :: Monad m => NetBytes d s (m a) -> m (NetBytes d s a) #

Applicative (NetBytes d s) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

pure :: a -> NetBytes d s a #

(<*>) :: NetBytes d s (a -> b) -> NetBytes d s a -> NetBytes d s b #

liftA2 :: (a -> b -> c) -> NetBytes d s a -> NetBytes d s b -> NetBytes d s c #

(*>) :: NetBytes d s a -> NetBytes d s b -> NetBytes d s b #

(<*) :: NetBytes d s a -> NetBytes d s b -> NetBytes d s a #

Functor (NetBytes d s) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

fmap :: (a -> b) -> NetBytes d s a -> NetBytes d s b #

(<$) :: a -> NetBytes d s b -> NetBytes d s a #

Monad (NetBytes d s) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

(>>=) :: NetBytes d s a -> (a -> NetBytes d s b) -> NetBytes d s b #

(>>) :: NetBytes d s a -> NetBytes d s b -> NetBytes d s b #

return :: a -> NetBytes d s a #

AGroup n => AGroup (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

(.-.) :: NetBytes d s n -> NetBytes d s n -> NetBytes d s n Source #

AMonoid n => AMonoid (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

zero :: NetBytes d s n Source #

ASemigroup n => ASemigroup (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

(.+.) :: NetBytes d s n -> NetBytes d s n -> NetBytes d s n Source #

MetricSpace n => MetricSpace (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

diffR :: NetBytes d s n -> NetBytes d s n -> Double Source #

Normed n => Normed (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

norm :: NetBytes d s n -> NetBytes d s n Source #

sgn :: NetBytes d s n -> NetBytes d s n Source #

FromInteger n => FromInteger (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

fromZ :: Integer -> NetBytes d s n Source #

FromRational n => FromRational (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

fromQ :: Rational -> NetBytes d s n Source #

FromReal n => FromReal (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

fromR :: Double -> NetBytes d s n Source #

ToInteger n => ToInteger (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

toZ :: NetBytes d s n -> Integer Source #

ToRational n => ToRational (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

toQ :: NetBytes d s n -> Rational Source #

ToReal n => ToReal (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

toR :: NetBytes d s n -> Double Source #

Generic (NetBytes d s n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type Rep (NetBytes d s n)	Since: si-bytes-0.1
Instance details Defined in Data.Bytes.Network.Internal type Rep (NetBytes d s n) = D1 ('MetaData "NetBytes" "Data.Bytes.Network.Internal" "si-bytes-0.1-inplace" 'True) (C1 ('MetaCons "MkNetBytes" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Bytes s n))))

Methods

from :: NetBytes d s n -> Rep (NetBytes d s n) x #

to :: Rep (NetBytes d s n) x -> NetBytes d s n #

Show n => Show (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

showsPrec :: Int -> NetBytes d s n -> ShowS #

show :: NetBytes d s n -> String #

showList :: [NetBytes d s n] -> ShowS #

LowerBounded n => LowerBounded (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

lowerBound :: NetBytes d s n Source #

LowerBoundless (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

MaybeLowerBounded n => MaybeLowerBounded (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

maybeLowerBound :: Maybe (NetBytes d s n) Source #

MaybeUpperBounded n => MaybeUpperBounded (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

maybeUpperBound :: Maybe (NetBytes d s n) Source #

UpperBounded n => UpperBounded (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

upperBound :: NetBytes d s n Source #

UpperBoundless (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

NFData n => NFData (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

rnf :: NetBytes d s n -> () #

Eq n => Eq (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

(==) :: NetBytes d s n -> NetBytes d s n -> Bool #

(/=) :: NetBytes d s n -> NetBytes d s n -> Bool #

Ord n => Ord (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

compare :: NetBytes d s n -> NetBytes d s n -> Ordering #

(<) :: NetBytes d s n -> NetBytes d s n -> Bool #

(<=) :: NetBytes d s n -> NetBytes d s n -> Bool #

(>) :: NetBytes d s n -> NetBytes d s n -> Bool #

(>=) :: NetBytes d s n -> NetBytes d s n -> Bool #

max :: NetBytes d s n -> NetBytes d s n -> NetBytes d s n #

min :: NetBytes d s n -> NetBytes d s n -> NetBytes d s n #

Hashable n => Hashable (NetBytes d s n) Source #

@since 0.1,

Instance details

Defined in Data.Bytes.Network.Internal

Methods

hashWithSalt :: Int -> NetBytes d s n -> Int Source #

hash :: NetBytes d s n -> Int Source #

(FromInteger n, MGroup n, SingI s) => Conversion (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

convert_ :: forall (t :: Size). SingI t => NetBytes d s n -> Converted t (NetBytes d s n) Source #

(FromInteger n, MGroup n, Normed n, Ord n, SingI s) => Normalize (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type Norm (NetBytes d s n)
Instance details Defined in Data.Bytes.Network.Internal type Norm (NetBytes d s n) = SomeNetSize d n

Methods

normalize :: NetBytes d s n -> Norm (NetBytes d s n) Source #

Read n => Parser (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

parser :: Parsec Void Text (NetBytes d s n) Source #

RawNumeric (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type Raw (NetBytes d s n)
Instance details Defined in Data.Bytes.Network.Internal type Raw (NetBytes d s n) = n

Methods

toRaw :: NetBytes d s n -> Raw (NetBytes d s n) Source #

SingI d => Directed (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type HideDirection (NetBytes d s n)
Instance details Defined in Data.Bytes.Network.Internal type HideDirection (NetBytes d s n) = SomeNetDir s n

Methods

directionOf :: NetBytes d s n -> Direction Source #

hideDirection :: NetBytes d s n -> HideDirection (NetBytes d s n) Source #

SingI s => Sized (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type HideSize (NetBytes d s n)
Instance details Defined in Data.Bytes.Network.Internal type HideSize (NetBytes d s n) = SomeNetSize d n

Methods

sizeOf :: NetBytes d s n -> Size Source #

hideSize :: NetBytes d s n -> HideSize (NetBytes d s n) Source #

MSemigroup n => MSemiSpace (NetBytes d s n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

(.*) :: NetBytes d s n -> n -> NetBytes d s n Source #

MGroup n => MSpace (NetBytes d s n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

(.%) :: NetBytes d s n -> n -> NetBytes d s n Source #

Ring n => Module (NetBytes d s n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Semiring n => Semimodule (NetBytes d s n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Semifield n => SemivectorSpace (NetBytes d s n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Field n => VectorSpace (NetBytes d s n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

type Converted t (NetBytes d s n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type Converted t (NetBytes d s n) = NetBytes d t n

type Rep (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

type Rep (NetBytes d s n) = D1 ('MetaData "NetBytes" "Data.Bytes.Network.Internal" "si-bytes-0.1-inplace" 'True) (C1 ('MetaCons "MkNetBytes" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Bytes s n))))

type Norm (NetBytes d s n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type Norm (NetBytes d s n) = SomeNetSize d n

type Raw (NetBytes d s n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type Raw (NetBytes d s n) = n

type HideDirection (NetBytes d s n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type HideDirection (NetBytes d s n) = SomeNetDir s n

type HideSize (NetBytes d s n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type HideSize (NetBytes d s n) = SomeNetSize d n

data Size Source #

Byte units.

Since: 0.1

Constructors

B	Bytes Since: 0.1
K	Kilobytes Since: 0.1
M	Megabytes Since: 0.1
G	Gigabytes Since: 0.1
T	Terabytes Since: 0.1
P	Petabytes Since: 0.1
E	Exabytes Since: 0.1
Z	Zettabytes Since: 0.1
Y	Yottabytes Since: 0.1

Instances

Instances details

Bounded Size Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Methods

minBound :: Size #

maxBound :: Size #

Enum Size Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Methods

succ :: Size -> Size #

pred :: Size -> Size #

toEnum :: Int -> Size #

fromEnum :: Size -> Int #

enumFrom :: Size -> [Size] #

enumFromThen :: Size -> Size -> [Size] #

enumFromTo :: Size -> Size -> [Size] #

enumFromThenTo :: Size -> Size -> Size -> [Size] #

Generic Size Source #

Instance details

Defined in Data.Bytes.Size

Associated Types

type Rep Size

Since: si-bytes-0.1

Instance details

Defined in Data.Bytes.Size

Methods

from :: Size -> Rep Size x #

to :: Rep Size x -> Size #

Show Size Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Methods

showsPrec :: Int -> Size -> ShowS #

show :: Size -> String #

showList :: [Size] -> ShowS #

NFData Size Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Methods

rnf :: Size -> () #

Eq Size Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Methods

(==) :: Size -> Size -> Bool #

(/=) :: Size -> Size -> Bool #

Ord Size Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Methods

compare :: Size -> Size -> Ordering #

(<) :: Size -> Size -> Bool #

(<=) :: Size -> Size -> Bool #

(>) :: Size -> Size -> Bool #

(>=) :: Size -> Size -> Bool #

max :: Size -> Size -> Size #

min :: Size -> Size -> Size #

Hashable Size Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Methods

hashWithSalt :: Int -> Size -> Int Source #

hash :: Size -> Int Source #

Parser Size Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Methods

parser :: Parsec Void Text Size Source #

SingKind Size Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Associated Types

type Demote Size
Instance details Defined in Data.Bytes.Size type Demote Size = Size

Methods

fromSing :: forall (a :: Size). Sing a -> Demote Size Source #

toSing :: Demote Size -> SomeSing Size Source #

TestEquality SSize Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Methods

testEquality :: forall (a :: Size) (b :: Size). SSize a -> SSize b -> Maybe (a :~: b) #

SingI 'B Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Methods

sing :: Sing 'B Source #

SingI 'E Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Methods

sing :: Sing 'E Source #

SingI 'G Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Methods

sing :: Sing 'G Source #

SingI 'K Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Methods

sing :: Sing 'K Source #

SingI 'M Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Methods

sing :: Sing 'M Source #

SingI 'P Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Methods

sing :: Sing 'P Source #

SingI 'T Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Methods

sing :: Sing 'T Source #

SingI 'Y Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Methods

sing :: Sing 'Y Source #

SingI 'Z Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

Methods

sing :: Sing 'Z Source #

type Rep Size Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

type Demote Size Source #

Instance details

Defined in Data.Bytes.Size

type Demote Size = Size

type Sing Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Size

type Sing = SSize

data Direction Source #

Tags for differentiating downloaded vs. uploaded bytes.

Since: 0.1

Constructors

Down	Since: 0.1
Up	Since: 0.1

Instances

Instances details

Generic Direction Source #

Instance details

Defined in Data.Bytes.Network.Direction

Associated Types

type Rep Direction	Since: si-bytes-0.1
Instance details Defined in Data.Bytes.Network.Direction type Rep Direction = D1 ('MetaData "Direction" "Data.Bytes.Network.Direction" "si-bytes-0.1-inplace" 'False) (C1 ('MetaCons "Down" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Up" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: Direction -> Rep Direction x #

to :: Rep Direction x -> Direction #

Show Direction Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Direction

Methods

showsPrec :: Int -> Direction -> ShowS #

show :: Direction -> String #

showList :: [Direction] -> ShowS #

NFData Direction Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Direction

Methods

rnf :: Direction -> () #

Eq Direction Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Direction

Methods

(==) :: Direction -> Direction -> Bool #

(/=) :: Direction -> Direction -> Bool #

Hashable Direction Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Direction

Methods

hashWithSalt :: Int -> Direction -> Int Source #

hash :: Direction -> Int Source #

Parser Direction Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Direction

Methods

parser :: Parsec Void Text Direction Source #

SingKind Direction Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Direction

Associated Types

type Demote Direction
Instance details Defined in Data.Bytes.Network.Direction type Demote Direction = Direction

Methods

fromSing :: forall (a :: Direction). Sing a -> Demote Direction Source #

toSing :: Demote Direction -> SomeSing Direction Source #

TestEquality SDirection Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Direction

Methods

testEquality :: forall (a :: Direction) (b :: Direction). SDirection a -> SDirection b -> Maybe (a :~: b) #

SingI 'Down Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Direction

Methods

sing :: Sing 'Down Source #

SingI 'Up Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Direction

Methods

sing :: Sing 'Up Source #

type Rep Direction Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Direction

type Rep Direction = D1 ('MetaData "Direction" "Data.Bytes.Network.Direction" "si-bytes-0.1-inplace" 'False) (C1 ('MetaCons "Down" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Up" 'PrefixI 'False) (U1 :: Type -> Type))

type Demote Direction Source #

Instance details

Defined in Data.Bytes.Network.Direction

type Demote Direction = Direction

type Sing Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Direction

type Sing = SDirection

Basic Usage

Construction

There are several ways to construct a NetBytes type.

FromInteger

>>> fromZ 80 :: NetBytes Up M Int
MkNetBytes (MkBytes 80)

Directly

>>> import Data.Bytes (Bytes (MkBytes))
>>> MkNetBytes (MkBytes 80) :: NetBytes Down M Int
MkNetBytes (MkBytes 80)

>>> -- using the @MkNetBytesP :: n -> NetBytes d s n@ pattern synonym
>>> MkNetBytesP 80 :: NetBytes Up K Int
MkNetBytes (MkBytes 80)

Optics (optics-core)

>>> -- 1. Using _MkNetBytes to construct a NetBytes from a Bytes
>>> import Optics.Core (review, (%))
>>> import Data.Bytes (_MkBytes)
>>> (review _MkNetBytes (MkBytes 80)) :: NetBytes Up G Int -- Bytes -> NetBytes
MkNetBytes (MkBytes 80)

>>> -- 2. Using _MkNetBytes and _MkBytes to construct a NetBytes from a
>>> --    numeric value.
>>> (review (_MkNetBytes % _MkBytes) 70) :: NetBytes Up G Int -- n -> NetBytes
MkNetBytes (MkBytes 70)

>>> -- 3. Using #unNetBytes to construct a NetBytes from a numeric value.
>>> (review #unNetBytes 70) :: NetBytes Up G Int -- n -> NetBytes
MkNetBytes (MkBytes 70)

Unknown Size

We sometimes have to deal with unknown sizes at runtime, which presents a problem. We handle this with the SomeNetSize type, which existentially quantifies the Size:

data SomeNetSize (d :: Direction) n Source #

Wrapper for NetBytes, existentially quantifying the size. This is useful when a function does not know a priori what size it should return e.g.

>>> :{
  getUpTraffic :: IO (SomeNetSize Up Float)
  getUpTraffic = do
    -- getUpTrafficRaw :: IO (Float, String)
    (bytes, units) <- getUpTrafficRaw
    pure $ case units of
      "B" -> hideSize $ MkNetBytesP @Up @B bytes
      "K" -> hideSize $ MkNetBytesP @Up @K bytes
      _ -> error "todo"
:}

We define an equivalence relation on SomeNetSize that takes units into account. For instance,

>>> hideSize (MkNetBytesP @Up @K 1000) == hideSize (MkNetBytesP @Up @M 1)
True

Because we expose the underlying NetBytes in several ways (e.g. Show, the SSize witness), this is technically unlawful for equality as it breaks the extensionality law:

\[ x = y \implies f(x) = f(y). \]

Since: 0.1

Instances

Instances details

HasField "unSomeNetSize" (SomeNetSize d n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

getField :: SomeNetSize d n -> n #

(k ~ A_Getter, a ~ n, b ~ n) => LabelOptic "unSomeNetSize" k (SomeNetSize d n) (SomeNetSize d n) a b Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

labelOptic :: Optic k NoIx (SomeNetSize d n) (SomeNetSize d n) a b Source #

Foldable (SomeNetSize d) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

fold :: Monoid m => SomeNetSize d m -> m #

foldMap :: Monoid m => (a -> m) -> SomeNetSize d a -> m #

foldMap' :: Monoid m => (a -> m) -> SomeNetSize d a -> m #

foldr :: (a -> b -> b) -> b -> SomeNetSize d a -> b #

foldr' :: (a -> b -> b) -> b -> SomeNetSize d a -> b #

foldl :: (b -> a -> b) -> b -> SomeNetSize d a -> b #

foldl' :: (b -> a -> b) -> b -> SomeNetSize d a -> b #

foldr1 :: (a -> a -> a) -> SomeNetSize d a -> a #

foldl1 :: (a -> a -> a) -> SomeNetSize d a -> a #

toList :: SomeNetSize d a -> [a] #

null :: SomeNetSize d a -> Bool #

length :: SomeNetSize d a -> Int #

elem :: Eq a => a -> SomeNetSize d a -> Bool #

maximum :: Ord a => SomeNetSize d a -> a #

minimum :: Ord a => SomeNetSize d a -> a #

sum :: Num a => SomeNetSize d a -> a #

product :: Num a => SomeNetSize d a -> a #

Traversable (SomeNetSize d) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

traverse :: Applicative f => (a -> f b) -> SomeNetSize d a -> f (SomeNetSize d b) #

sequenceA :: Applicative f => SomeNetSize d (f a) -> f (SomeNetSize d a) #

mapM :: Monad m => (a -> m b) -> SomeNetSize d a -> m (SomeNetSize d b) #

sequence :: Monad m => SomeNetSize d (m a) -> m (SomeNetSize d a) #

Functor (SomeNetSize d) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

fmap :: (a -> b) -> SomeNetSize d a -> SomeNetSize d b #

(<$) :: a -> SomeNetSize d b -> SomeNetSize d a #

(Field n, FromInteger n) => AGroup (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

(.-.) :: SomeNetSize d n -> SomeNetSize d n -> SomeNetSize d n Source #

(FromInteger n, Semifield n) => AMonoid (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

zero :: SomeNetSize d n Source #

(ASemigroup n, FromInteger n, MGroup n) => ASemigroup (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

(.+.) :: SomeNetSize d n -> SomeNetSize d n -> SomeNetSize d n Source #

(FromInteger n, MetricSpace n, MGroup n) => MetricSpace (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

diffR :: SomeNetSize d n -> SomeNetSize d n -> Double Source #

Normed n => Normed (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

norm :: SomeNetSize d n -> SomeNetSize d n Source #

sgn :: SomeNetSize d n -> SomeNetSize d n Source #

FromInteger n => FromInteger (SomeNetSize d n) Source #

Fixed size B.

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

fromZ :: Integer -> SomeNetSize d n Source #

FromRational n => FromRational (SomeNetSize d n) Source #

Fixed size B.

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

fromQ :: Rational -> SomeNetSize d n Source #

FromReal n => FromReal (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

fromR :: Double -> SomeNetSize d n Source #

(FromInteger n, MGroup n, ToInteger n) => ToInteger (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

toZ :: SomeNetSize d n -> Integer Source #

(FromInteger n, MGroup n, ToRational n) => ToRational (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

toQ :: SomeNetSize d n -> Rational Source #

(FromInteger n, MGroup n, ToReal n) => ToReal (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

toR :: SomeNetSize d n -> Double Source #

Show n => Show (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

showsPrec :: Int -> SomeNetSize d n -> ShowS #

show :: SomeNetSize d n -> String #

showList :: [SomeNetSize d n] -> ShowS #

NFData n => NFData (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

rnf :: SomeNetSize d n -> () #

(Eq n, FromInteger n, MGroup n) => Eq (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

(==) :: SomeNetSize d n -> SomeNetSize d n -> Bool #

(/=) :: SomeNetSize d n -> SomeNetSize d n -> Bool #

(FromInteger n, MGroup n, Ord n) => Ord (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

compare :: SomeNetSize d n -> SomeNetSize d n -> Ordering #

(<) :: SomeNetSize d n -> SomeNetSize d n -> Bool #

(<=) :: SomeNetSize d n -> SomeNetSize d n -> Bool #

(>) :: SomeNetSize d n -> SomeNetSize d n -> Bool #

(>=) :: SomeNetSize d n -> SomeNetSize d n -> Bool #

max :: SomeNetSize d n -> SomeNetSize d n -> SomeNetSize d n #

min :: SomeNetSize d n -> SomeNetSize d n -> SomeNetSize d n #

(FromInteger n, Hashable n, MGroup n) => Hashable (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

hashWithSalt :: Int -> SomeNetSize d n -> Int Source #

hash :: SomeNetSize d n -> Int Source #

(FromInteger n, MGroup n) => Conversion (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

convert_ :: forall (t :: Size). SingI t => SomeNetSize d n -> Converted t (SomeNetSize d n) Source #

(FromInteger n, MGroup n, Normed n, Ord n) => Normalize (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type Norm (SomeNetSize d n)
Instance details Defined in Data.Bytes.Network.Internal type Norm (SomeNetSize d n) = SomeNetSize d n

Methods

normalize :: SomeNetSize d n -> Norm (SomeNetSize d n) Source #

Read n => Parser (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

parser :: Parsec Void Text (SomeNetSize d n) Source #

RawNumeric (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type Raw (SomeNetSize d n)
Instance details Defined in Data.Bytes.Network.Internal type Raw (SomeNetSize d n) = n

Methods

toRaw :: SomeNetSize d n -> Raw (SomeNetSize d n) Source #

SingI d => Directed (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type HideDirection (SomeNetSize d n)
Instance details Defined in Data.Bytes.Network.Internal type HideDirection (SomeNetSize d n) = SomeNet n

Methods

directionOf :: SomeNetSize d n -> Direction Source #

hideDirection :: SomeNetSize d n -> HideDirection (SomeNetSize d n) Source #

Sized (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type HideSize (SomeNetSize d n)
Instance details Defined in Data.Bytes.Network.Internal type HideSize (SomeNetSize d n) = SomeNetSize d n

Methods

sizeOf :: SomeNetSize d n -> Size Source #

hideSize :: SomeNetSize d n -> HideSize (SomeNetSize d n) Source #

MGroup n => MSemiSpace (SomeNetSize d n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

(.*) :: SomeNetSize d n -> n -> SomeNetSize d n Source #

MGroup n => MSpace (SomeNetSize d n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

(.%) :: SomeNetSize d n -> n -> SomeNetSize d n Source #

(Field n, FromInteger n) => Module (SomeNetSize d n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

(FromInteger n, Semifield n) => Semimodule (SomeNetSize d n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

(FromInteger n, Semifield n) => SemivectorSpace (SomeNetSize d n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

(FromInteger n, Field n) => VectorSpace (SomeNetSize d n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

type Converted t (SomeNetSize d n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type Converted t (SomeNetSize d n) = NetBytes d t n

type Norm (SomeNetSize d n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type Norm (SomeNetSize d n) = SomeNetSize d n

type Raw (SomeNetSize d n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type Raw (SomeNetSize d n) = n

type HideDirection (SomeNetSize d n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type HideDirection (SomeNetSize d n) = SomeNet n

type HideSize (SomeNetSize d n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type HideSize (SomeNetSize d n) = SomeNetSize d n

Sized

Fortunately, we do not have to directly use the constructor or singletons. We can instead use the Sized class.

class Sized a where Source #

Types that have a size.

Since: 0.1

Associated Types

type HideSize a Source #

Type used to hide the size.

Since: 0.1

Methods

sizeOf :: a -> Size Source #

Retrieves the size.

Examples

Expand

>>> import Data.Bytes (Bytes (..))
>>> sizeOf (MkBytes @G 7)
G

>>> sizeOf (hideSize $ MkBytes @M 7)
M

>>> import Data.Bytes.Network (NetBytes (..), Direction (..))
>>> sizeOf (hideSize $ MkNetBytesP @Up @M 7)
M

Since: 0.1

hideSize :: a -> HideSize a Source #

Hides the size.

Examples

Expand

>>> import Data.Bytes (Bytes (..))
>>> hideSize (MkBytes @G 7)
MkSomeSize SG (MkBytes 7)

Instances

Instances details

Sized (SomeSize n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Internal

Associated Types

type HideSize (SomeSize n)
Instance details Defined in Data.Bytes.Internal type HideSize (SomeSize n) = SomeSize n

Methods

sizeOf :: SomeSize n -> Size Source #

hideSize :: SomeSize n -> HideSize (SomeSize n) Source #

Sized (SomeNet n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type HideSize (SomeNet n)
Instance details Defined in Data.Bytes.Network.Internal type HideSize (SomeNet n) = SomeNet n

Methods

sizeOf :: SomeNet n -> Size Source #

hideSize :: SomeNet n -> HideSize (SomeNet n) Source #

SingI s => Sized (Bytes s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Internal

Associated Types

type HideSize (Bytes s n)
Instance details Defined in Data.Bytes.Internal type HideSize (Bytes s n) = SomeSize n

Methods

sizeOf :: Bytes s n -> Size Source #

hideSize :: Bytes s n -> HideSize (Bytes s n) Source #

SingI s => Sized (SomeNetDir s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type HideSize (SomeNetDir s n)
Instance details Defined in Data.Bytes.Network.Internal type HideSize (SomeNetDir s n) = SomeNet n

Methods

sizeOf :: SomeNetDir s n -> Size Source #

hideSize :: SomeNetDir s n -> HideSize (SomeNetDir s n) Source #

Sized (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type HideSize (SomeNetSize d n)
Instance details Defined in Data.Bytes.Network.Internal type HideSize (SomeNetSize d n) = SomeNetSize d n

Methods

sizeOf :: SomeNetSize d n -> Size Source #

hideSize :: SomeNetSize d n -> HideSize (SomeNetSize d n) Source #

SingI s => Sized (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type HideSize (NetBytes d s n)
Instance details Defined in Data.Bytes.Network.Internal type HideSize (NetBytes d s n) = SomeNetSize d n

Methods

sizeOf :: NetBytes d s n -> Size Source #

hideSize :: NetBytes d s n -> HideSize (NetBytes d s n) Source #

Optics

Once again, we can use optics for this.

>>> import Optics.Core (review)
>>> review _MkSomeNetSize (MkNetBytesP 70 :: NetBytes Down G Int)
MkSomeNetSize SG (MkNetBytes (MkBytes 70))

Unknown Direction

Like sizes, we can also handle unknown directions at runtime. The types involved here are SomeNetDir (hiding direction only) and SomeNet (hiding both direction and size).

data SomeNetDir (s :: Size) n Source #

Wrapper for NetBytes, existentially quantifying the direction. This is useful when a function does not know a priori what direction it should return e.g.

>>> :{
  getMaxTraffic :: IO (SomeNetDir K Double)
  getMaxTraffic = do
    -- getMaxTraffickRaw :: IO (Double, String)
    (bytes, direction) <- getMaxTraffickRaw
    pure $ case direction of
      "down" -> hideDirection $ MkNetBytesP @Down bytes
      "up" -> hideDirection $ MkNetBytesP @Up bytes
      _ -> error "bad direction"
:}

We deliberately do not provide instances for SomeX classes that could be used to combine arbitrary SomeNetDirs (e.g. Applicative, AGroup), as that would defeat the purpose of enforcing the distinction between upload and downloaded bytes.

Equality is determined by the usual equivalence class -- that takes units into account -- and by considering the direction.

>>> let x = MkNetBytesP @Up @K 1000 :: NetBytes Up K Int
>>> let y = MkNetBytesP @Down @K 1000 :: NetBytes Down K Int
>>> hideDirection x == hideDirection x
True
>>> hideDirection x == hideDirection y
False

Notice no Ord instance is provided, as we provide no ordering for Direction.

Since: 0.1

Instances

Instances details

HasField "unSomeNetDir" (SomeNetDir s n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

getField :: SomeNetDir s n -> n #

(k ~ A_Getter, a ~ n, b ~ n) => LabelOptic "unSomeNetDir" k (SomeNetDir s n) (SomeNetDir s n) a b Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

labelOptic :: Optic k NoIx (SomeNetDir s n) (SomeNetDir s n) a b Source #

Foldable (SomeNetDir s) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

fold :: Monoid m => SomeNetDir s m -> m #

foldMap :: Monoid m => (a -> m) -> SomeNetDir s a -> m #

foldMap' :: Monoid m => (a -> m) -> SomeNetDir s a -> m #

foldr :: (a -> b -> b) -> b -> SomeNetDir s a -> b #

foldr' :: (a -> b -> b) -> b -> SomeNetDir s a -> b #

foldl :: (b -> a -> b) -> b -> SomeNetDir s a -> b #

foldl' :: (b -> a -> b) -> b -> SomeNetDir s a -> b #

foldr1 :: (a -> a -> a) -> SomeNetDir s a -> a #

foldl1 :: (a -> a -> a) -> SomeNetDir s a -> a #

toList :: SomeNetDir s a -> [a] #

null :: SomeNetDir s a -> Bool #

length :: SomeNetDir s a -> Int #

elem :: Eq a => a -> SomeNetDir s a -> Bool #

maximum :: Ord a => SomeNetDir s a -> a #

minimum :: Ord a => SomeNetDir s a -> a #

sum :: Num a => SomeNetDir s a -> a #

product :: Num a => SomeNetDir s a -> a #

Traversable (SomeNetDir d) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

traverse :: Applicative f => (a -> f b) -> SomeNetDir d a -> f (SomeNetDir d b) #

sequenceA :: Applicative f => SomeNetDir d (f a) -> f (SomeNetDir d a) #

mapM :: Monad m => (a -> m b) -> SomeNetDir d a -> m (SomeNetDir d b) #

sequence :: Monad m => SomeNetDir d (m a) -> m (SomeNetDir d a) #

Functor (SomeNetDir s) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

fmap :: (a -> b) -> SomeNetDir s a -> SomeNetDir s b #

(<$) :: a -> SomeNetDir s b -> SomeNetDir s a #

Normed n => Normed (SomeNetDir s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

norm :: SomeNetDir s n -> SomeNetDir s n Source #

sgn :: SomeNetDir s n -> SomeNetDir s n Source #

Show n => Show (SomeNetDir s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

showsPrec :: Int -> SomeNetDir s n -> ShowS #

show :: SomeNetDir s n -> String #

showList :: [SomeNetDir s n] -> ShowS #

NFData n => NFData (SomeNetDir s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

rnf :: SomeNetDir s n -> () #

(Eq n, FromInteger n, SingI s) => Eq (SomeNetDir s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

(==) :: SomeNetDir s n -> SomeNetDir s n -> Bool #

(/=) :: SomeNetDir s n -> SomeNetDir s n -> Bool #

(FromInteger n, Hashable n, MGroup n, SingI s) => Hashable (SomeNetDir s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

hashWithSalt :: Int -> SomeNetDir s n -> Int Source #

hash :: SomeNetDir s n -> Int Source #

(FromInteger n, MGroup n, SingI s) => Conversion (SomeNetDir s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

convert_ :: forall (t :: Size). SingI t => SomeNetDir s n -> Converted t (SomeNetDir s n) Source #

(FromInteger n, MGroup n, Normed n, Ord n, SingI s) => Normalize (SomeNetDir s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type Norm (SomeNetDir s n)
Instance details Defined in Data.Bytes.Network.Internal type Norm (SomeNetDir s n) = SomeNet n

Methods

normalize :: SomeNetDir s n -> Norm (SomeNetDir s n) Source #

Read n => Parser (SomeNetDir s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

parser :: Parsec Void Text (SomeNetDir s n) Source #

RawNumeric (SomeNetDir s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type Raw (SomeNetDir s n)
Instance details Defined in Data.Bytes.Network.Internal type Raw (SomeNetDir s n) = n

Methods

toRaw :: SomeNetDir s n -> Raw (SomeNetDir s n) Source #

Directed (SomeNetDir s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type HideDirection (SomeNetDir s n)
Instance details Defined in Data.Bytes.Network.Internal type HideDirection (SomeNetDir s n) = SomeNetDir s n

Methods

directionOf :: SomeNetDir s n -> Direction Source #

hideDirection :: SomeNetDir s n -> HideDirection (SomeNetDir s n) Source #

SingI s => Sized (SomeNetDir s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type HideSize (SomeNetDir s n)
Instance details Defined in Data.Bytes.Network.Internal type HideSize (SomeNetDir s n) = SomeNet n

Methods

sizeOf :: SomeNetDir s n -> Size Source #

hideSize :: SomeNetDir s n -> HideSize (SomeNetDir s n) Source #

MSemigroup n => MSemiSpace (SomeNetDir s n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

(.*) :: SomeNetDir s n -> n -> SomeNetDir s n Source #

MGroup n => MSpace (SomeNetDir s n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

(.%) :: SomeNetDir s n -> n -> SomeNetDir s n Source #

type Converted t (SomeNetDir s n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type Converted t (SomeNetDir s n) = SomeNetDir t n

type Norm (SomeNetDir s n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type Norm (SomeNetDir s n) = SomeNet n

type Raw (SomeNetDir s n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type Raw (SomeNetDir s n) = n

type HideDirection (SomeNetDir s n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type HideDirection (SomeNetDir s n) = SomeNetDir s n

type HideSize (SomeNetDir s n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type HideSize (SomeNetDir s n) = SomeNet n

data SomeNet n Source #

Wrapper for NetBytes, existentially quantifying the size and direction. This is useful when a function does not know a priori what size or direction it should return e.g.

>>> :{
  getMaxTraffic :: IO (SomeNet Double)
  getMaxTraffic = do
    -- getMaxTrafficNetRaw :: IO (Double, String, String)
    (bytes, direction, size) <- getMaxTrafficNetRaw
    pure $ case (direction, size) of
      ("Down", "K") -> hideDirection $ hideSize $ MkNetBytesP @Down @K bytes
      ("Up", "M") -> hideDirection $ hideSize $ MkNetBytesP @Up @M bytes
      _ -> error "todo"
:}

SomeNet carries along SDirection and SSize runtime witnesses for recovering the Direction and Size, respectively.

This instance uses the same equivalence relation from SomeNetSize w.r.t the size, and also includes an equality check on the direction. Thus we have, for instance,

>>> let x = MkNetBytesP 1_000 :: NetBytes Up K Int
>>> let y = MkNetBytesP 1 :: NetBytes Up M Int
>>> let z = MkNetBytesP 1_000 :: NetBytes Down K Int
>>> hideDirection (hideSize x) == hideDirection (hideSize y)
True

>>> hideDirection (hideSize x) == hideDirection (hideSize z)
False

Since: 0.1

Instances

Instances details

Foldable SomeNet Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

fold :: Monoid m => SomeNet m -> m #

foldMap :: Monoid m => (a -> m) -> SomeNet a -> m #

foldMap' :: Monoid m => (a -> m) -> SomeNet a -> m #

foldr :: (a -> b -> b) -> b -> SomeNet a -> b #

foldr' :: (a -> b -> b) -> b -> SomeNet a -> b #

foldl :: (b -> a -> b) -> b -> SomeNet a -> b #

foldl' :: (b -> a -> b) -> b -> SomeNet a -> b #

foldr1 :: (a -> a -> a) -> SomeNet a -> a #

foldl1 :: (a -> a -> a) -> SomeNet a -> a #

toList :: SomeNet a -> [a] #

null :: SomeNet a -> Bool #

length :: SomeNet a -> Int #

elem :: Eq a => a -> SomeNet a -> Bool #

maximum :: Ord a => SomeNet a -> a #

minimum :: Ord a => SomeNet a -> a #

sum :: Num a => SomeNet a -> a #

product :: Num a => SomeNet a -> a #

Traversable SomeNet Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

traverse :: Applicative f => (a -> f b) -> SomeNet a -> f (SomeNet b) #

sequenceA :: Applicative f => SomeNet (f a) -> f (SomeNet a) #

mapM :: Monad m => (a -> m b) -> SomeNet a -> m (SomeNet b) #

sequence :: Monad m => SomeNet (m a) -> m (SomeNet a) #

Functor SomeNet Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

fmap :: (a -> b) -> SomeNet a -> SomeNet b #

(<$) :: a -> SomeNet b -> SomeNet a #

HasField "unSomeNet" (SomeNet n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

getField :: SomeNet n -> n #

(k ~ A_Getter, a ~ n, b ~ n) => LabelOptic "unSomeNet" k (SomeNet n) (SomeNet n) a b Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

labelOptic :: Optic k NoIx (SomeNet n) (SomeNet n) a b Source #

Normed n => Normed (SomeNet n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

norm :: SomeNet n -> SomeNet n Source #

sgn :: SomeNet n -> SomeNet n Source #

Show n => Show (SomeNet n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

showsPrec :: Int -> SomeNet n -> ShowS #

show :: SomeNet n -> String #

showList :: [SomeNet n] -> ShowS #

NFData n => NFData (SomeNet n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

rnf :: SomeNet n -> () #

(Eq n, FromInteger n, MGroup n) => Eq (SomeNet n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

(==) :: SomeNet n -> SomeNet n -> Bool #

(/=) :: SomeNet n -> SomeNet n -> Bool #

(FromInteger n, Hashable n, MGroup n) => Hashable (SomeNet n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

hashWithSalt :: Int -> SomeNet n -> Int Source #

hash :: SomeNet n -> Int Source #

(FromInteger n, MGroup n) => Conversion (SomeNet n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

convert_ :: forall (t :: Size). SingI t => SomeNet n -> Converted t (SomeNet n) Source #

(FromInteger n, MGroup n, Normed n, Ord n) => Normalize (SomeNet n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type Norm (SomeNet n)
Instance details Defined in Data.Bytes.Network.Internal type Norm (SomeNet n) = SomeNet n

Methods

normalize :: SomeNet n -> Norm (SomeNet n) Source #

Read n => Parser (SomeNet n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

parser :: Parsec Void Text (SomeNet n) Source #

RawNumeric (SomeNet n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type Raw (SomeNet n)
Instance details Defined in Data.Bytes.Network.Internal type Raw (SomeNet n) = n

Methods

toRaw :: SomeNet n -> Raw (SomeNet n) Source #

Directed (SomeNet n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type HideDirection (SomeNet n)
Instance details Defined in Data.Bytes.Network.Internal type HideDirection (SomeNet n) = SomeNet n

Methods

directionOf :: SomeNet n -> Direction Source #

hideDirection :: SomeNet n -> HideDirection (SomeNet n) Source #

Sized (SomeNet n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type HideSize (SomeNet n)
Instance details Defined in Data.Bytes.Network.Internal type HideSize (SomeNet n) = SomeNet n

Methods

sizeOf :: SomeNet n -> Size Source #

hideSize :: SomeNet n -> HideSize (SomeNet n) Source #

MSemigroup n => MSemiSpace (SomeNet n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

(.*) :: SomeNet n -> n -> SomeNet n Source #

MGroup n => MSpace (SomeNet n) n Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Methods

(.%) :: SomeNet n -> n -> SomeNet n Source #

type Converted t (SomeNet n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type Converted t (SomeNet n) = SomeNetDir t n

type Norm (SomeNet n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type Norm (SomeNet n) = SomeNet n

type Raw (SomeNet n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type Raw (SomeNet n) = n

type HideDirection (SomeNet n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type HideDirection (SomeNet n) = SomeNet n

type HideSize (SomeNet n) Source #

Instance details

Defined in Data.Bytes.Network.Internal

type HideSize (SomeNet n) = SomeNet n

Analogous to the Sized class, we have Directed.

class Directed a where Source #

Types that have a direction.

Since: 0.1

Associated Types

type HideDirection a Source #

Type used to hide the size.

Since: 0.1

Methods

directionOf :: a -> Direction Source #

Retrieve the direction.

Examples

Expand

>>> import Data.Bytes.Network
>>> directionOf (MkNetBytesP @Up @G 7)
Up

>>> directionOf (hideSize $ hideDirection $ MkNetBytesP @Down @M 100)
Down

Since: 0.1

hideDirection :: a -> HideDirection a Source #

Hides the direction.

Examples

Expand

>>> import Data.Bytes.Network (NetBytes (..), Size (..))
>>> hideDirection (MkNetBytesP @Up @G 7)
MkSomeNetDir SUp (MkNetBytes (MkBytes 7))

Since: 0.1

Instances

Instances details

Directed (SomeNet n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type HideDirection (SomeNet n)
Instance details Defined in Data.Bytes.Network.Internal type HideDirection (SomeNet n) = SomeNet n

Methods

directionOf :: SomeNet n -> Direction Source #

hideDirection :: SomeNet n -> HideDirection (SomeNet n) Source #

Directed (SomeNetDir s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type HideDirection (SomeNetDir s n)
Instance details Defined in Data.Bytes.Network.Internal type HideDirection (SomeNetDir s n) = SomeNetDir s n

Methods

directionOf :: SomeNetDir s n -> Direction Source #

hideDirection :: SomeNetDir s n -> HideDirection (SomeNetDir s n) Source #

SingI d => Directed (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type HideDirection (SomeNetSize d n)
Instance details Defined in Data.Bytes.Network.Internal type HideDirection (SomeNetSize d n) = SomeNet n

Methods

directionOf :: SomeNetSize d n -> Direction Source #

hideDirection :: SomeNetSize d n -> HideDirection (SomeNetSize d n) Source #

SingI d => Directed (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type HideDirection (NetBytes d s n)
Instance details Defined in Data.Bytes.Network.Internal type HideDirection (NetBytes d s n) = SomeNetDir s n

Methods

directionOf :: NetBytes d s n -> Direction Source #

hideDirection :: NetBytes d s n -> HideDirection (NetBytes d s n) Source #

Once again, we can use optics for this.

>>> import Optics.Core (review)
>>> let x = MkNetBytesP 70 :: NetBytes Down G Int
>>> review _MkSomeNetDir x
MkSomeNetDir SDown (MkNetBytes (MkBytes 70))

>>> review _MkSomeNet x
MkSomeNet SDown SG (MkNetBytes (MkBytes 70))

Elimination

RawNumeric

We provide the RawNumeric class for conveniently unwrapping a type to the underlying numeric value.

class RawNumeric a where Source #

Abstracts "wrapper" types for generically retrieving a raw numeric value.

Since: 0.1

Associated Types

type Raw a Source #

Since: 0.1

Methods

toRaw :: a -> Raw a Source #

Retrieves the underlying value.

Examples

Expand

>>> import Data.Bytes (Bytes (..), Size (..), Sized (..))
>>> toRaw (MkBytes @G 7)
7

>>> toRaw (hideSize $ MkBytes @M 400)
400

>>> import Data.Bytes.Network (Direction (..), NetBytes (..))
>>> toRaw (MkNetBytesP @Up @G 7)
7

>>> toRaw (hideSize $ MkNetBytesP @Up @G 7)
7

Since: 0.1

Instances

Instances details

RawNumeric (SomeSize n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Internal

Associated Types

type Raw (SomeSize n)
Instance details Defined in Data.Bytes.Internal type Raw (SomeSize n) = n

Methods

toRaw :: SomeSize n -> Raw (SomeSize n) Source #

RawNumeric (SomeNet n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type Raw (SomeNet n)
Instance details Defined in Data.Bytes.Network.Internal type Raw (SomeNet n) = n

Methods

toRaw :: SomeNet n -> Raw (SomeNet n) Source #

RawNumeric (Bytes s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Internal

Associated Types

type Raw (Bytes s n)
Instance details Defined in Data.Bytes.Internal type Raw (Bytes s n) = n

Methods

toRaw :: Bytes s n -> Raw (Bytes s n) Source #

RawNumeric (SomeNetDir s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type Raw (SomeNetDir s n)
Instance details Defined in Data.Bytes.Network.Internal type Raw (SomeNetDir s n) = n

Methods

toRaw :: SomeNetDir s n -> Raw (SomeNetDir s n) Source #

RawNumeric (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type Raw (SomeNetSize d n)
Instance details Defined in Data.Bytes.Network.Internal type Raw (SomeNetSize d n) = n

Methods

toRaw :: SomeNetSize d n -> Raw (SomeNetSize d n) Source #

RawNumeric (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type Raw (NetBytes d s n)
Instance details Defined in Data.Bytes.Network.Internal type Raw (NetBytes d s n) = n

Methods

toRaw :: NetBytes d s n -> Raw (NetBytes d s n) Source #

HasField

We can use HasField for this too.

>>> -- {-# LANGUAGE OverloadedRecordDot #-}
>>> let x1 = MkNetBytesP 7 :: NetBytes Up G Int
>>> x1.unNetBytes
7

>>> let x2 = hideSize x1 :: SomeNetSize Up Int
>>> x2.unSomeNetSize
7

>>> let x3 = (hideDirection x1) :: SomeNetDir G Int
>>> x3.unSomeNetDir
7

>>> let x4 = (hideDirection x2) :: SomeNet Int
>>> x4.unSomeNet
7

Optics

Optics are another option. The underscore-prefixed optics unwrap one level at a time, since we can freely compose them.

>>> import Optics.Core (view, (%))
>>> import Data.Bytes (_MkBytes)
>>> let x1 = MkNetBytesP 7 :: NetBytes Up G Int
>>> view (_MkNetBytes % _MkBytes) x1
7

>>> -- notice we have to convert the numeric value since the requested
>>> -- return type ('M') differs from the original ('G')
>>> let x2 = hideSize x1 :: SomeNetSize Up Int
>>> (view _MkSomeNetSize x2) :: NetBytes Up M Int
MkNetBytes (MkBytes 7000)

>>> view (_MkSomeNetSize % (_MkNetBytes @M) % _MkBytes) x2
7000

The -XOverloadedLabel instances unwrap all the way to the underlying numeric value.

>>> view #unNetBytes x1
7

>>> view #unSomeNetSize x2
7

>>> let x3 = hideDirection x1 :: SomeNetDir G Int
>>> view #unSomeNetDir x3
7

>>> let x4 = hideSize x3 :: SomeNet Int
>>> view #unSomeNet x4
7

Transformations

Converting Units

class Conversion a where Source #

This class allows one to transform a bytes type to any Size. For types with existentially quantified Size (e.g. SomeSize, SomeNetSize), this will "undo" the existential quantification.

Since: 0.1

Associated Types

type Converted (t :: Size) a = (r :: Type) | r -> t Source #

Since: 0.1

Methods

convert_ :: forall (t :: Size). SingI t => a -> Converted t a Source #

convert_ @_ @t x converts x to size t.

Examples

Expand

>>> let bytes = MkBytes 50_000 :: Bytes 'M Int
>>> let gBytes = convert_ @_ @G bytes
>>> :type gBytes
gBytes :: Bytes G Int
>>> gBytes
MkBytes 50

>>> let bytes = hideSize (MkBytes 0.2 :: Bytes 'T Float)
>>> let mBytes = convert_ @_ @M bytes
>>> :type mBytes
mBytes :: Bytes M Float
>>> mBytes
MkBytes 200000.0

Since: 0.1

Instances

Instances details

(FromInteger n, MGroup n) => Conversion (SomeSize n) Source #	Since: 0.1
Instance details Defined in Data.Bytes.Internal Methods convert_ :: forall (t :: Size). SingI t => SomeSize n -> Converted t (SomeSize n) Source #
(FromInteger n, MGroup n) => Conversion (SomeNet n) Source #	Since: 0.1
Instance details Defined in Data.Bytes.Network.Internal Methods convert_ :: forall (t :: Size). SingI t => SomeNet n -> Converted t (SomeNet n) Source #
(FromInteger n, MGroup n, SingI s) => Conversion (Bytes s n) Source #	Since: 0.1
Instance details Defined in Data.Bytes.Internal Methods convert_ :: forall (t :: Size). SingI t => Bytes s n -> Converted t (Bytes s n) Source #
(FromInteger n, MGroup n, SingI s) => Conversion (SomeNetDir s n) Source #	Since: 0.1
Instance details Defined in Data.Bytes.Network.Internal Methods convert_ :: forall (t :: Size). SingI t => SomeNetDir s n -> Converted t (SomeNetDir s n) Source #
(FromInteger n, MGroup n) => Conversion (SomeNetSize d n) Source #	Since: 0.1
Instance details Defined in Data.Bytes.Network.Internal Methods convert_ :: forall (t :: Size). SingI t => SomeNetSize d n -> Converted t (SomeNetSize d n) Source #
(FromInteger n, MGroup n, SingI s) => Conversion (NetBytes d s n) Source #	Since: 0.1
Instance details Defined in Data.Bytes.Network.Internal Methods convert_ :: forall (t :: Size). SingI t => NetBytes d s n -> Converted t (NetBytes d s n) Source #

Normalization

class Normalize a where Source #

Used for normalizing bytes b such that

\[ 1 \le \text{normalize}(b) < 1000 \iff 1\text{ B} \le b < 1000\text{ Y}. \]

In the strictest sense, $\textrm{normalize} : \mathcal{C} \rightarrow \mathcal{C}$ is not a homomorphism, as the combination of two normalized values may itself not be normalized.

However, because the normalized units varies with the value, normalize always returns a type that existentially quantifies the size (e.g. SomeSize). Eq for these types is defined in terms of an equivalence class that takes units into account e.g. 1 P = 1,000 T = 1,000,000 G .... Viewed this way, normalize is actually an isomorphism, as it is essentially a no-op, never leaving the equivalence class.

This means we can happily mix normalization with different functions without worrying about the order. The only requirement we have is that such functions respect substitution:

\[ x = y \implies f(x) = f(y). \]

This is certainly true for all the usual mathematical operations we would normally use, e.g., AGroup addition, Module scalar multiplication. On the other hand, any functions that inspect the underlying numeric value or Bytes types could easily break this law. As such they should be treated with suspicion, at least when used in conjunction with normalize.

The other consideration we must keep in mind is that the final result of a series of computations may not be normalized. If this is desired, then normalize should be the last operation performed. Using normalize in the middle would not cause any harm (other than, perhaps, impacting efficiency), but it would not guarantee the final result is normalized.

Since: 0.1

Associated Types

type Norm a Source #

Since: 0.1

Methods

normalize :: a -> Norm a Source #

Normalizes the value.

Examples

Expand

>>> let bytes = MkBytes 5000 :: Bytes 'M Int
>>> normalize bytes
MkSomeSize SG (MkBytes 5)

>>> let bytes = hideSize (MkBytes 0.01 :: Bytes 'T Float)
>>> normalize bytes
MkSomeSize SG (MkBytes 10.0)

Since: 0.1

Instances

Instances details

(FromInteger n, MGroup n, Normed n, Ord n) => Normalize (SomeSize n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Internal

Associated Types

type Norm (SomeSize n)
Instance details Defined in Data.Bytes.Internal type Norm (SomeSize n) = SomeSize n

Methods

normalize :: SomeSize n -> Norm (SomeSize n) Source #

(FromInteger n, MGroup n, Normed n, Ord n) => Normalize (SomeNet n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type Norm (SomeNet n)
Instance details Defined in Data.Bytes.Network.Internal type Norm (SomeNet n) = SomeNet n

Methods

normalize :: SomeNet n -> Norm (SomeNet n) Source #

(FromInteger n, MGroup n, Normed n, Ord n, SingI s) => Normalize (Bytes s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Internal

Associated Types

type Norm (Bytes s n)
Instance details Defined in Data.Bytes.Internal type Norm (Bytes s n) = SomeSize n

Methods

normalize :: Bytes s n -> Norm (Bytes s n) Source #

(FromInteger n, MGroup n, Normed n, Ord n, SingI s) => Normalize (SomeNetDir s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type Norm (SomeNetDir s n)
Instance details Defined in Data.Bytes.Network.Internal type Norm (SomeNetDir s n) = SomeNet n

Methods

normalize :: SomeNetDir s n -> Norm (SomeNetDir s n) Source #

(FromInteger n, MGroup n, Normed n, Ord n) => Normalize (SomeNetSize d n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type Norm (SomeNetSize d n)
Instance details Defined in Data.Bytes.Network.Internal type Norm (SomeNetSize d n) = SomeNetSize d n

Methods

normalize :: SomeNetSize d n -> Norm (SomeNetSize d n) Source #

(FromInteger n, MGroup n, Normed n, Ord n, SingI s) => Normalize (NetBytes d s n) Source #

Since: 0.1

Instance details

Defined in Data.Bytes.Network.Internal

Associated Types

type Norm (NetBytes d s n)
Instance details Defined in Data.Bytes.Network.Internal type Norm (NetBytes d s n) = SomeNetSize d n

Methods

normalize :: NetBytes d s n -> Norm (NetBytes d s n) Source #

Algebra

The built-in Num class is abandoned in favor of algebra-simple's algebraic hierarchy based on abstract algebra. This is motivated by a desire to:

Provide a consistent API.
Avoid Num's infelicities (e.g. nonsense multiplication, dangerous fromInteger).

NetBytes and SomeNetSize are both AGroups. A Ring instance is not provided because multiplication is nonsensical:

\[ x \;\textrm{mb} \times y \;\textrm{mb} = xy \;\textrm{mb}^2. \]

Fortunately, multiplying bytes by some kind of scalar is both useful and has an easy interpretation: NetBytes forms a Module over a Ring (resp. VectorSpace over a Field). This allows us to multiply a NetBytes or SomeNetSize by a scalar in a manner consistent with the above API.

Examples

Addition/Subtraction

>>> import Numeric.Algebra (ASemigroup ((.+.)), AGroup ((.-.)))
>>> let mb1 = MkNetBytesP 20 :: NetBytes 'Down 'M Int
>>> let mb2 = MkNetBytesP 50 :: NetBytes 'Down 'M Int
>>> mb1 .+. mb2
MkNetBytes (MkBytes 70)
>>> mb1 .-. mb2
MkNetBytes (MkBytes (-30))

>>> let kb = MkNetBytesP 50 :: NetBytes 'Down 'K Int
>>> -- mb1 .+. kb -- This would be a type error

>>> let mbUp = MkNetBytesP 50 :: NetBytes 'Up 'M Int
>>> -- mb1 .+. mbUp -- This would be a type error

Multiplication

>>> import Numeric.Algebra (MSemiSpace ((.*)))
>>> mb1 .* 10
MkNetBytes (MkBytes 200)

Division

>>> import Numeric.Algebra (MSpace ((.%)))
>>> mb1 .% 10
MkNetBytes (MkBytes 2)

One may wonder how the AGroup instance for SomeNetSize could possibly work. It is possible (indeed, expected) that we could have two SomeNetSizes that have different underlying NetBytes types. To handle this, the SomeNetSize instance will convert both NetBytes to a NetBytes 'B before adding/subtracting.

>>> let some1 = hideSize (MkNetBytesP 1000 :: NetBytes 'Down 'G Double)
>>> let some2 = hideSize (MkNetBytesP 500_000 :: NetBytes 'Down 'M Double)
>>> some1 .+. some2
MkSomeNetSize SB (MkNetBytes (MkBytes 1.5e12))
>>> some1 .-. some2
MkSomeNetSize SB (MkNetBytes (MkBytes 5.0e11))

This respects SomeNetSize's equivalence-class base Eq.

module Numeric.Algebra

module Numeric.Convert.Integer

module Numeric.Convert.Rational

module Numeric.Convert.Real

Text

Pretty Printing

We provide several formatters for pretty-printing different byte types.

>>> import Data.Default (Default (def))
>>> let bf = MkFloatingFormatter (Just 2)
>>> let b = MkNetBytesP @Up @G @Float 203.301
>>> formatSizedDirected bf def def b
"203.30 gb up"

module Data.Bytes.Formatting

Parsing

class Parser a Source #

Represents a megaparsec parser. Used for parsing byte types from Text.

Since: 0.1

Minimal complete definition

parser

Instances

Instances details

Parser Direction Source #	Since: 0.1
Instance details Defined in Data.Bytes.Network.Direction Methods parser :: Parsec Void Text Direction Source #
Parser Size Source #	Since: 0.1
Instance details Defined in Data.Bytes.Size Methods parser :: Parsec Void Text Size Source #
Read n => Parser (SomeSize n) Source #	Since: 0.1
Instance details Defined in Data.Bytes.Internal Methods parser :: Parsec Void Text (SomeSize n) Source #
Read n => Parser (SomeNet n) Source #	Since: 0.1
Instance details Defined in Data.Bytes.Network.Internal Methods parser :: Parsec Void Text (SomeNet n) Source #
Read n => Parser (Bytes s n) Source #	Since: 0.1
Instance details Defined in Data.Bytes.Internal Methods parser :: Parsec Void Text (Bytes s n) Source #
Read n => Parser (SomeNetDir s n) Source #	Since: 0.1
Instance details Defined in Data.Bytes.Network.Internal Methods parser :: Parsec Void Text (SomeNetDir s n) Source #
Read n => Parser (SomeNetSize d n) Source #	Since: 0.1
Instance details Defined in Data.Bytes.Network.Internal Methods parser :: Parsec Void Text (SomeNetSize d n) Source #
Read n => Parser (NetBytes d s n) Source #	Since: 0.1
Instance details Defined in Data.Bytes.Network.Internal Methods parser :: Parsec Void Text (NetBytes d s n) Source #

parse :: Parser a => Text -> Either Text a Source #

Parses various byte types from Text. Parsing is lenient in general. We support:

Case-insensitivity.
Optional leading/internal/trailing whitespace.
Flexible names.

Bytes Examples

Expand

>>> import Data.Bytes (Bytes, Size (..), SomeSize)
>>> parse @(Bytes M Int) "70"
Right (MkBytes 70)

>>> parse @(SomeSize Float) "100.45 kilobytes"
Right (MkSomeSize SK (MkBytes 100.45))

>>> parse @(SomeSize Word) "2300G"
Right (MkSomeSize SG (MkBytes 2300))

>>> parse @(SomeSize Float) "5.5 tb"
Right (MkSomeSize ST (MkBytes 5.5))

Network Examples

Expand

>>> import Data.Bytes.Network (Direction (..), NetBytes, SomeNet, SomeNetDir, SomeNetSize)
>>> parse @(NetBytes Up M Int) "70"
Right (MkNetBytes (MkBytes 70))

>>> parse @(SomeNetSize Down Float) "100.45 kilobytes"
Right (MkSomeNetSize SK (MkNetBytes (MkBytes 100.45)))

>>> parse @(SomeNetSize Up Word) "2300G"
Right (MkSomeNetSize SG (MkNetBytes (MkBytes 2300)))

>>> parse @(SomeNetDir T Word) "2300 up"
Right (MkSomeNetDir SUp (MkNetBytes (MkBytes 2300)))

>>> parse @(SomeNetDir M Word) "2300D"
Right (MkSomeNetDir SDown (MkNetBytes (MkBytes 2300)))

>>> parse @(SomeNet Float) "5.5 tb Up"
Right (MkSomeNet SUp ST (MkNetBytes (MkBytes 5.5)))

>>> parse @(SomeNet Float) "5.5 megabytes DOWN"
Right (MkSomeNet SDown SM (MkNetBytes (MkBytes 5.5)))

Since: 0.1

Optics

Core

_MkNetBytes :: forall (s :: Size) (d :: Direction) n. Iso' (NetBytes d s n) (Bytes s n) Source #

Iso' between NetBytes and underlying Bytes.

Examples

Expand

>>> import Optics.Core (review, view)
>>> review _MkNetBytes (MkBytes @K @Int 70)
MkNetBytes (MkBytes 70)

>>> view _MkNetBytes (MkNetBytes $ MkBytes @K @Int 70)
MkBytes 70

Since: 0.1

_MkSomeNetSize :: forall (s :: Size) (d :: Direction) n. (FromInteger n, MGroup n, SingI s) => Iso' (SomeNetSize d n) (NetBytes d s n) Source #

Iso' between SomeNetSize and underlying NetBytes. Performs any necessary conversions when going from SomeNetSize d n -> NetBytes d s n.

Examples

Expand

>>> import Optics.Core (review, view)
>>> review _MkSomeNetSize (MkNetBytesP @Up @K @Int 70)
MkSomeNetSize SK (MkNetBytes (MkBytes 70))

>>> (view _MkSomeNetSize (hideSize $ MkNetBytesP @Up @K @Int 70)) :: NetBytes Up B Int
MkNetBytes (MkBytes 70000)

Since: 0.1

_MkSomeNetDir :: forall (s :: Size) (d :: Direction) n. SingI d => Review (SomeNetDir s n) (NetBytes d s n) Source #

Review between SomeNetDir and underlying NetBytes. This is not an iso (i.e. only allows NetBytes -> SomeNetDir) because the opposite direction would require dropping the Direction and the user arbitrarily choosing a new one.

Examples

Expand

>>> import Optics.Core (review)
>>> review _MkSomeNetDir (MkNetBytesP @Up @K @Int 70)
MkSomeNetDir SUp (MkNetBytes (MkBytes 70))

Since: 0.1

_MkSomeNet :: forall (s :: Size) (d :: Direction) n. (SingI d, SingI s) => Review (SomeNet n) (NetBytes d s n) Source #

Review between SomeNet and underlying NetBytes. This is not an iso (i.e. only allows NetBytes -> SomeNet) because the opposite direction would require dropping the Direction and the user arbitrarily choosing a new one.

Examples

Expand

>>> import Optics.Core (review)
>>> review _MkSomeNet (MkNetBytesP @Up @K @Int 70)
MkSomeNet SUp SK (MkNetBytes (MkBytes 70))

Since: 0.1

Size

_B :: Prism' Size () Source #

Since: 0.1

_K :: Prism' Size () Source #

Since: 0.1

_M :: Prism' Size () Source #

Since: 0.1

_G :: Prism' Size () Source #

Since: 0.1

_T :: Prism' Size () Source #

Since: 0.1

_P :: Prism' Size () Source #

Since: 0.1

_E :: Prism' Size () Source #

Since: 0.1

_Z :: Prism' Size () Source #

Since: 0.1

_Y :: Prism' Size () Source #

Since: 0.1

Direction

_Down :: Prism' Direction () Source #

Since: 0.1

_Up :: Prism' Direction () Source #

Since: 0.1

Reexports

class Default a where Source #

A class for types with a default value.

Minimal complete definition

Nothing

Methods

def :: a Source #

The default value for this type.

default def :: (Generic a, GDefault (Rep a)) => a Source #

Instances

Instances details

Default All
Instance details Defined in Data.Default.Class Methods def :: All Source #
Default Any
Instance details Defined in Data.Default.Class Methods def :: Any Source #
Default CClock
Instance details Defined in Data.Default.Class Methods def :: CClock Source #
Default CDouble
Instance details Defined in Data.Default.Class Methods def :: CDouble Source #
Default CFloat
Instance details Defined in Data.Default.Class Methods def :: CFloat Source #
Default CInt
Instance details Defined in Data.Default.Class Methods def :: CInt Source #
Default CIntMax
Instance details Defined in Data.Default.Class Methods def :: CIntMax Source #
Default CIntPtr
Instance details Defined in Data.Default.Class Methods def :: CIntPtr Source #
Default CLLong
Instance details Defined in Data.Default.Class Methods def :: CLLong Source #
Default CLong
Instance details Defined in Data.Default.Class Methods def :: CLong Source #
Default CPtrdiff
Instance details Defined in Data.Default.Class Methods def :: CPtrdiff Source #
Default CSUSeconds
Instance details Defined in Data.Default.Class Methods def :: CSUSeconds Source #
Default CShort
Instance details Defined in Data.Default.Class Methods def :: CShort Source #
Default CSigAtomic
Instance details Defined in Data.Default.Class Methods def :: CSigAtomic Source #
Default CSize
Instance details Defined in Data.Default.Class Methods def :: CSize Source #
Default CTime
Instance details Defined in Data.Default.Class Methods def :: CTime Source #
Default CUInt
Instance details Defined in Data.Default.Class Methods def :: CUInt Source #
Default CUIntMax
Instance details Defined in Data.Default.Class Methods def :: CUIntMax Source #
Default CUIntPtr
Instance details Defined in Data.Default.Class Methods def :: CUIntPtr Source #
Default CULLong
Instance details Defined in Data.Default.Class Methods def :: CULLong Source #
Default CULong
Instance details Defined in Data.Default.Class Methods def :: CULong Source #
Default CUSeconds
Instance details Defined in Data.Default.Class Methods def :: CUSeconds Source #
Default CUShort
Instance details Defined in Data.Default.Class Methods def :: CUShort Source #
Default Int16
Instance details Defined in Data.Default.Class Methods def :: Int16 Source #
Default Int32
Instance details Defined in Data.Default.Class Methods def :: Int32 Source #
Default Int64
Instance details Defined in Data.Default.Class Methods def :: Int64 Source #
Default Int8
Instance details Defined in Data.Default.Class Methods def :: Int8 Source #
Default Word16
Instance details Defined in Data.Default.Class Methods def :: Word16 Source #
Default Word32
Instance details Defined in Data.Default.Class Methods def :: Word32 Source #
Default Word64
Instance details Defined in Data.Default.Class Methods def :: Word64 Source #
Default Word8
Instance details Defined in Data.Default.Class Methods def :: Word8 Source #
Default Ordering
Instance details Defined in Data.Default.Class Methods def :: Ordering Source #
Default DirectedFormatter Source #	Since: 0.1
Instance details Defined in Data.Bytes.Formatting.Direction Methods def :: DirectedFormatter Source #
Default DirectionFormat Source #	Since: 0.1
Instance details Defined in Data.Bytes.Formatting.Direction Methods def :: DirectionFormat Source #
Default SizeFormat Source #	Since: 0.1
Instance details Defined in Data.Bytes.Formatting.Size Methods def :: SizeFormat Source #
Default SizedFormatter Source #
Instance details Defined in Data.Bytes.Formatting.Size Methods def :: SizedFormatter Source #
Default Integer
Instance details Defined in Data.Default.Class Methods def :: Integer Source #
Default ()
Instance details Defined in Data.Default.Class Methods def :: () Source #
Default Double
Instance details Defined in Data.Default.Class Methods def :: Double Source #
Default Float
Instance details Defined in Data.Default.Class Methods def :: Float Source #
Default Int
Instance details Defined in Data.Default.Class Methods def :: Int Source #
Default Word
Instance details Defined in Data.Default.Class Methods def :: Word Source #
(Default a, RealFloat a) => Default (Complex a)
Instance details Defined in Data.Default.Class Methods def :: Complex a Source #
Default (First a)
Instance details Defined in Data.Default.Class Methods def :: First a Source #
Default (Last a)
Instance details Defined in Data.Default.Class Methods def :: Last a Source #
Default a => Default (Dual a)
Instance details Defined in Data.Default.Class Methods def :: Dual a Source #
Default (Endo a)
Instance details Defined in Data.Default.Class Methods def :: Endo a Source #
Num a => Default (Product a)
Instance details Defined in Data.Default.Class Methods def :: Product a Source #
Num a => Default (Sum a)
Instance details Defined in Data.Default.Class Methods def :: Sum a Source #
Integral a => Default (Ratio a)
Instance details Defined in Data.Default.Class Methods def :: Ratio a Source #
Default a => Default (IO a)
Instance details Defined in Data.Default.Class Methods def :: IO a Source #
Default (Maybe a)
Instance details Defined in Data.Default.Class Methods def :: Maybe a Source #
Default [a]
Instance details Defined in Data.Default.Class Methods def :: [a] Source #
(Default a, Default b) => Default (a, b)
Instance details Defined in Data.Default.Class Methods def :: (a, b) Source #
Default r => Default (e -> r)
Instance details Defined in Data.Default.Class Methods def :: e -> r Source #
(Default a, Default b, Default c) => Default (a, b, c)
Instance details Defined in Data.Default.Class Methods def :: (a, b, c) Source #
(Default a, Default b, Default c, Default d) => Default (a, b, c, d)
Instance details Defined in Data.Default.Class Methods def :: (a, b, c, d) Source #
(Default a, Default b, Default c, Default d, Default e) => Default (a, b, c, d, e)
Instance details Defined in Data.Default.Class Methods def :: (a, b, c, d, e) Source #
(Default a, Default b, Default c, Default d, Default e, Default f) => Default (a, b, c, d, e, f)
Instance details Defined in Data.Default.Class Methods def :: (a, b, c, d, e, f) Source #
(Default a, Default b, Default c, Default d, Default e, Default f, Default g) => Default (a, b, c, d, e, f, g)
Instance details Defined in Data.Default.Class Methods def :: (a, b, c, d, e, f, g) Source #