Data.Monoid.Recommend

A type for representing values with an additional bit saying whether the value is "just a recommendation" (to be used only if nothing better comes along) or a "committment" (to certainly be used, overriding merely recommended values), along with corresponding Semigroup and Monoid instances.

Documentation

data Recommend a

A value of type Recommend a consists of a value of type a wrapped up in one of two constructors. The Recommend constructor indicates a "non-committal recommendation"---that is, the given value should be used if no other/better values are available. The Commit constructor indicates a "commitment"---a value which should definitely be used, overriding any Recommended values.

Constructors

Recommend a

Commit a

Instances

Show a => Show (Recommend a)

(Semigroup a, Monoid a) => Monoid (Recommend a)

Semigroup a => Semigroup (Recommend a)

Commit overrides Recommend. Two values wrapped in the same constructor (both Recommend or both Commit) are combined according to the underlying Semigroup instance.

getRecommend :: Recommend a -> a

Extract the value of type a wrapped in Recommend a.