Safe Haskell	Safe

Ganeti.PartialParams

Description

Common functions for partial parameters

Synopsis

class PartialParams f p | p -> f, f -> p where
- fillParams :: f -> p -> f
- toPartial :: f -> p
- toFilled :: p -> Maybe f
isComplete :: PartialParams f p => p -> Bool

Documentation

class PartialParams f p | p -> f, f -> p where Source #

Represents that data type p provides partial values for data type f.

Note: To avoid needless type annotations, the functional dependencies currently include f -> p. However, in theory it'd be possible for one filled data type to have several partially filled ones.

Laws:

fillParams (fillParams f p) p = fillParams f p.
fillParams _ (toPartial x) = x.
toFilled (toPartial x) = Just x.

If p is also a Monoid (or just Semigroup), fillParams is a monoid (semigroup) action on f, therefore it should additionally satisfy:

```
fillParams f mempty = f
```

fillParams f (p1 <> p2) = fillParams (fillParams f p1) p2

Methods

fillParams :: f -> p -> f Source #

Fill f with any data that are set in p. Leave other parts of f unchanged.

toPartial :: f -> p Source #

Fill all fields of p from f.

toFilled :: p -> Maybe f Source #

If all fields of p are filled, convert it into f.

Instances

Instances details

PartialParams FilledNicParams PartialNicParams #
Instance details Defined in Ganeti.Objects.Nic Methods fillParams :: FilledNicParams -> PartialNicParams -> FilledNicParams Source # toPartial :: FilledNicParams -> PartialNicParams Source # toFilled :: PartialNicParams -> Maybe FilledNicParams Source #
PartialParams FilledBeParams PartialBeParams #
Instance details Defined in Ganeti.Objects.Instance Methods fillParams :: FilledBeParams -> PartialBeParams -> FilledBeParams Source # toPartial :: FilledBeParams -> PartialBeParams Source # toFilled :: PartialBeParams -> Maybe FilledBeParams Source #
PartialParams FilledISpecParams PartialISpecParams #
Instance details Defined in Ganeti.Objects Methods fillParams :: FilledISpecParams -> PartialISpecParams -> FilledISpecParams Source # toPartial :: FilledISpecParams -> PartialISpecParams Source # toFilled :: PartialISpecParams -> Maybe FilledISpecParams Source #
PartialParams FilledIPolicy PartialIPolicy #	Custom filler for the ipolicy types.
Instance details Defined in Ganeti.Objects Methods fillParams :: FilledIPolicy -> PartialIPolicy -> FilledIPolicy Source # toPartial :: FilledIPolicy -> PartialIPolicy Source # toFilled :: PartialIPolicy -> Maybe FilledIPolicy Source #
PartialParams FilledNDParams PartialNDParams #
Instance details Defined in Ganeti.Objects Methods fillParams :: FilledNDParams -> PartialNDParams -> FilledNDParams Source # toPartial :: FilledNDParams -> PartialNDParams Source # toFilled :: PartialNDParams -> Maybe FilledNDParams Source #

isComplete :: PartialParams f p => p -> Bool Source #

Returns True if a given partial parameters are complete. See toFilled.