Copyright	(c) Alexandre Joannou 2019
License	MIT
Maintainer	alexandre.joannou@gmail.com
Stability	experimental
Safe Haskell	Safe-Inferred
Language	GHC2021

Blarney.Option

Contents

Option type

Description

An Option type, similar to Maybe in functionality but represented as a pair of a flag and a value.

Synopsis

data Option t = Option {
- valid :: Bit 1
- val :: t
}
some :: Bits t => t -> Option t
none :: Bits t => Option t
isSome :: Bits t => Option t -> Bit 1
isNone :: Bits t => Option t -> Bit 1
fromOption :: Bits t => t -> Option t -> t

Option type

data Option t Source #

Option type to wrap a value. An 'Option t' is represented as a pair of a 'Bit 1' indicating whether the value held is valid, and a value of type t.

Constructors

Option
Fields valid :: Bit 1 val :: t

Instances

Instances details

Functor Option #
Instance details Defined in Blarney.Option Methods fmap :: (a -> b) -> Option a -> Option b # (<$) :: a -> Option b -> Option a #
Generic (Option t) #
Instance details Defined in Blarney.Option Associated Types type Rep (Option t) :: Type -> Type # Methods from :: Option t -> Rep (Option t) x # to :: Rep (Option t) x -> Option t #
Cmp t => Cmp (Option t) #
Instance details Defined in Blarney.Option Methods (.<.) :: Option t -> Option t -> Bit 1 Source # (.<=.) :: Option t -> Option t -> Bit 1 Source # (.==.) :: Option t -> Option t -> Bit 1 Source # (.>.) :: Option t -> Option t -> Bit 1 Source # (.>=.) :: Option t -> Option t -> Bit 1 Source # (.!=.) :: Option t -> Option t -> Bit 1 Source #
Bits t => Bits (Option t) #
Instance details Defined in Blarney.Option Associated Types type SizeOf (Option t) :: Nat Source # Methods sizeOf :: Option t -> Int Source # pack :: Option t -> Bit (SizeOf (Option t)) Source # unpack :: Bit (SizeOf (Option t)) -> Option t Source # nameBits :: String -> Option t -> Option t Source #
FShow t => FShow (Option t) #
Instance details Defined in Blarney.Option Methods fshow :: Option t -> Format Source # fshowList :: [Option t] -> Format Source #
Interface t => Interface (Option t) #
Instance details Defined in Blarney.Option Methods toIfc :: Option t -> (IfcTerm, IfcType) Source # fromIfc :: IfcTerm -> Option t Source #
type Rep (Option t) #
Instance details Defined in Blarney.Option type Rep (Option t) = D1 ('MetaData "Option" "Blarney.Option" "blarney-0.1.0.0-inplace" 'False) (C1 ('MetaCons "Option" 'PrefixI 'True) (S1 ('MetaSel ('Just "valid") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Bit 1)) :*: S1 ('MetaSel ('Just "val") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 t)))
type SizeOf (Option t) #
Instance details Defined in Blarney.Option type SizeOf (Option t) = GSizeOf (Rep (Option t))

some :: Bits t => t -> Option t Source #

Builds an Option with a valid value

none :: Bits t => Option t Source #

Builds an invalid Option

isSome :: Bits t => Option t -> Bit 1 Source #

Tests if an Option is a some

isNone :: Bits t => Option t -> Bit 1 Source #

Tests if an Option is a none

fromOption :: Bits t => t -> Option t -> t Source #

Gets the value from a valid Option, or a given default value otherwise