Safe Haskell	Safe-Inferred
Language	Haskell2010

Pythia.Services.Types.Network

Contents

IP Types
- Refinements
Network Device
Optics

Description

Provides common network types.

Since: 0.1

Synopsis

data IpType
- = Ipv4
- | Ipv6
newtype IpAddress a = MkIpAddress {
- unIpAddress :: Refined (IpRefinement a) Text
}
newtype IpAddresses a = MkIpAddresses {
- unIpAddresses :: [IpAddress a]
}
type family IpRefinement a where ...
data Ipv4Refinement
data Ipv6Refinement
newtype Device = MkDevice {
- unDevice :: Text
}
_Ipv4 :: Prism' IpType ()
_Ipv6 :: Prism' IpType ()

IP Types

data IpType Source #

IP types.

Since: 0.1

Constructors

Ipv4	Since: 0.1
Ipv6	Since: 0.1

Instances

Instances details

Generic IpType Source #
Instance details Defined in Pythia.Services.Types.Network Associated Types type Rep IpType :: Type -> Type # Methods from :: IpType -> Rep IpType x # to :: Rep IpType x -> IpType #
Show IpType Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods showsPrec :: Int -> IpType -> ShowS # show :: IpType -> String # showList :: [IpType] -> ShowS #
NFData IpType Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods rnf :: IpType -> () #
Eq IpType Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods (==) :: IpType -> IpType -> Bool # (/=) :: IpType -> IpType -> Bool #
type Rep IpType Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network type Rep IpType = D1 ('MetaData "IpType" "Pythia.Services.Types.Network" "pythia-0.1-inplace" 'False) (C1 ('MetaCons "Ipv4" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Ipv6" 'PrefixI 'False) (U1 :: Type -> Type))

newtype IpAddress a Source #

Type for an IP address. The type family IpRefinement refines the underlying Text according to the spec.

Ipv4: All characters are digits or dots, and the length is 0 < l < 16.
Ipv6: All characters are hex digits or colons, and the length is 0 < l < 40.

Since: 0.1

Constructors

MkIpAddress
Fields unIpAddress :: Refined (IpRefinement a) Text Since: 0.1

Instances

Instances details

(k ~ An_Iso, a ~ Refined (IpRefinement s) Text, b ~ Refined (IpRefinement s) Text) => LabelOptic "unIpAddress" k (IpAddress s) (IpAddress s) a b Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods labelOptic :: Optic k NoIx (IpAddress s) (IpAddress s) a b Source #
Generic (IpAddress a) Source #
Instance details Defined in Pythia.Services.Types.Network Associated Types type Rep (IpAddress a) :: Type -> Type # Methods from :: IpAddress a -> Rep (IpAddress a) x # to :: Rep (IpAddress a) x -> IpAddress a #
Show (IpAddress a) Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods showsPrec :: Int -> IpAddress a -> ShowS # show :: IpAddress a -> String # showList :: [IpAddress a] -> ShowS #
NFData (IpAddress a) Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods rnf :: IpAddress a -> () #
Eq (IpAddress a) Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods (==) :: IpAddress a -> IpAddress a -> Bool # (/=) :: IpAddress a -> IpAddress a -> Bool #
Ord (IpAddress a) Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods compare :: IpAddress a -> IpAddress a -> Ordering # (<) :: IpAddress a -> IpAddress a -> Bool # (<=) :: IpAddress a -> IpAddress a -> Bool # (>) :: IpAddress a -> IpAddress a -> Bool # (>=) :: IpAddress a -> IpAddress a -> Bool # max :: IpAddress a -> IpAddress a -> IpAddress a # min :: IpAddress a -> IpAddress a -> IpAddress a #
Display (IpAddress a) Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods displayBuilder :: IpAddress a -> Builder Source # displayList :: [IpAddress a] -> Builder Source # displayPrec :: Int -> IpAddress a -> Builder Source #
type Rep (IpAddress a) Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network type Rep (IpAddress a) = D1 ('MetaData "IpAddress" "Pythia.Services.Types.Network" "pythia-0.1-inplace" 'True) (C1 ('MetaCons "MkIpAddress" 'PrefixI 'True) (S1 ('MetaSel ('Just "unIpAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Refined (IpRefinement a) Text))))

newtype IpAddresses a Source #

Since: 0.1

Constructors

MkIpAddresses
Fields unIpAddresses :: [IpAddress a] Since: 0.1

Instances

Instances details

(k ~ An_Iso, a ~ [IpAddress s], b ~ [IpAddress s]) => LabelOptic "unIpAddresses" k (IpAddresses s) (IpAddresses s) a b Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods labelOptic :: Optic k NoIx (IpAddresses s) (IpAddresses s) a b Source #
Monoid (IpAddresses a) Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods mempty :: IpAddresses a # mappend :: IpAddresses a -> IpAddresses a -> IpAddresses a # mconcat :: [IpAddresses a] -> IpAddresses a #
Semigroup (IpAddresses a) Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods (<>) :: IpAddresses a -> IpAddresses a -> IpAddresses a # sconcat :: NonEmpty (IpAddresses a) -> IpAddresses a # stimes :: Integral b => b -> IpAddresses a -> IpAddresses a #
Generic (IpAddresses a) Source #
Instance details Defined in Pythia.Services.Types.Network Associated Types type Rep (IpAddresses a) :: Type -> Type # Methods from :: IpAddresses a -> Rep (IpAddresses a) x # to :: Rep (IpAddresses a) x -> IpAddresses a #
IsList (IpAddresses a) Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Associated Types type Item (IpAddresses a) # Methods fromList :: [Item (IpAddresses a)] -> IpAddresses a # fromListN :: Int -> [Item (IpAddresses a)] -> IpAddresses a # toList :: IpAddresses a -> [Item (IpAddresses a)] #
Show (IpAddresses a) Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods showsPrec :: Int -> IpAddresses a -> ShowS # show :: IpAddresses a -> String # showList :: [IpAddresses a] -> ShowS #
NFData (IpAddresses a) Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods rnf :: IpAddresses a -> () #
Eq (IpAddresses a) Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods (==) :: IpAddresses a -> IpAddresses a -> Bool # (/=) :: IpAddresses a -> IpAddresses a -> Bool #
Ord (IpAddresses a) Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods compare :: IpAddresses a -> IpAddresses a -> Ordering # (<) :: IpAddresses a -> IpAddresses a -> Bool # (<=) :: IpAddresses a -> IpAddresses a -> Bool # (>) :: IpAddresses a -> IpAddresses a -> Bool # (>=) :: IpAddresses a -> IpAddresses a -> Bool # max :: IpAddresses a -> IpAddresses a -> IpAddresses a # min :: IpAddresses a -> IpAddresses a -> IpAddresses a #
Display (IpAddresses a) Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods displayBuilder :: IpAddresses a -> Builder Source # displayList :: [IpAddresses a] -> Builder Source # displayPrec :: Int -> IpAddresses a -> Builder Source #
type Rep (IpAddresses a) Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network type Rep (IpAddresses a) = D1 ('MetaData "IpAddresses" "Pythia.Services.Types.Network" "pythia-0.1-inplace" 'True) (C1 ('MetaCons "MkIpAddresses" 'PrefixI 'True) (S1 ('MetaSel ('Just "unIpAddresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [IpAddress a])))
type Item (IpAddresses a) Source #
Instance details Defined in Pythia.Services.Types.Network type Item (IpAddresses a) = IpAddress a

Refinements

type family IpRefinement a where ... Source #

Maps IpType to its Text refinement.

Since: 0.1

Equations

IpRefinement Ipv4 = Ipv4Refinement
IpRefinement Ipv6 = Ipv6Refinement

data Ipv4Refinement Source #

IPv4 Refinement. We implement a custom type here so we get better error messages. Text must satisfy:

Length in (0, 16).
Chars are all decimal digits or dots.

Examples

Expand

>>> R.refine @Ipv4Refinement @Text "192.168.1.2"
Right (Refined "192.168.1.2")

>>> trim $ R.refine @Ipv4Refinement @Text ""
"Left   The predicate (Ipv4Refinement) failed with the message: Expected IPv4 with length (0, 16). Received empty."

>>> trim $ R.refine @Ipv4Refinement @Text "192.168.111.222.7"
"Left   The predicate (Ipv4Refinement) failed with the message: Expected IPv4 address with length (0, 16). Received '192.168.111.222.7' of length 17"

>>> trim $ R.refine @Ipv4Refinement @Text "192.168x1.2"
"Left   The predicate (Ipv4Refinement) failed with the message: IPv4 address should only contain decimal digits or dots. Received invalid: 192.168x1.2"

Since: 0.1

Instances

Instances details

Predicate Ipv4Refinement Text Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods validate :: Proxy Ipv4Refinement -> Text -> Maybe RefineException Source #

data Ipv6Refinement Source #

IPv6 Refinement. We implement a custom type here so we get better error messages. Text must satisfy:

Length in (0, 40).
Chars are all hex digits or colons.

Examples

Expand

>>> R.refine @Ipv6Refinement @Text "fe80::a328:482:5263:10b8"
Right (Refined "fe80::a328:482:5263:10b8")

>>> trim $ R.refine @Ipv6Refinement @Text ""
"Left   The predicate (Ipv6Refinement) failed with the message: Expected IPv6 of length (0, 40). Received empty."

>>> trim $ R.refine @Ipv6Refinement @Text "fe80:a328:4822:5263:10b8:4062:10d3:16ac:"
"Left   The predicate (Ipv6Refinement) failed with the message: Expected IPv6 with length (0, 40). Received 'fe80:a328:4822:5263:10b8:4062:10d3:16ac:' of length 40"

>>> trim $ R.refine @Ipv6Refinement @Text "fe80::a328:482:5263:10b8x"
"Left   The predicate (Ipv6Refinement) failed with the message: IPv6 address should only contain hex digits or colons. Received invalid: fe80::a328:482:5263:10b8x"

Since: 0.1

Instances

Instances details

Predicate Ipv6Refinement Text Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods validate :: Proxy Ipv6Refinement -> Text -> Maybe RefineException Source #

Network Device

newtype Device Source #

Newtype wrapper over a network device name.

Since: 0.1

Constructors

MkDevice
Fields unDevice :: Text Since: 0.1

Instances

Instances details

IsString Device Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods fromString :: String -> Device #
Generic Device Source #
Instance details Defined in Pythia.Services.Types.Network Associated Types type Rep Device :: Type -> Type # Methods from :: Device -> Rep Device x # to :: Rep Device x -> Device #
Read Device Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods readsPrec :: Int -> ReadS Device # readList :: ReadS [Device] # readPrec :: ReadPrec Device # readListPrec :: ReadPrec [Device] #
Show Device Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods showsPrec :: Int -> Device -> ShowS # show :: Device -> String # showList :: [Device] -> ShowS #
NFData Device Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods rnf :: Device -> () #
Eq Device Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods (==) :: Device -> Device -> Bool # (/=) :: Device -> Device -> Bool #
Ord Device Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods compare :: Device -> Device -> Ordering # (<) :: Device -> Device -> Bool # (<=) :: Device -> Device -> Bool # (>) :: Device -> Device -> Bool # (>=) :: Device -> Device -> Bool # max :: Device -> Device -> Device # min :: Device -> Device -> Device #
Display Device Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods displayBuilder :: Device -> Builder Source # displayList :: [Device] -> Builder Source # displayPrec :: Int -> Device -> Builder Source #
(k ~ An_Iso, a ~ Text, b ~ Text) => LabelOptic "unDevice" k Device Device a b Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network Methods labelOptic :: Optic k NoIx Device Device a b Source #
type Rep Device Source #	Since: 0.1
Instance details Defined in Pythia.Services.Types.Network type Rep Device = D1 ('MetaData "Device" "Pythia.Services.Types.Network" "pythia-0.1-inplace" 'True) (C1 ('MetaCons "MkDevice" 'PrefixI 'True) (S1 ('MetaSel ('Just "unDevice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Optics

_Ipv4 :: Prism' IpType () Source #

Since: 0.1

_Ipv6 :: Prism' IpType () Source #

Since: 0.1