Safe Haskell	Safe-Inferred

Derive.Env

Contents

put

Synopsis

type Key = Text
data Environ
null :: Environ -> Bool
lookup :: Key -> Environ -> Maybe DeriveT.Val
insert :: Key -> DeriveT.Val -> Environ -> Environ
from_list :: [(Key, DeriveT.Val)] -> Environ
to_list :: Environ -> [(Key, DeriveT.Val)]
to_map :: Environ -> Map Key DeriveT.Val
from_map :: Map Key DeriveT.Val -> Environ
delete :: Key -> Environ -> Environ
is_set :: Key -> Environ -> Bool
map :: (DeriveT.Val -> DeriveT.Val) -> Environ -> Environ
from_controls :: ScoreT.ControlMap -> Environ
put_val :: Typecheck.ToVal a => Key -> a -> Environ -> Either Error Environ
modify_signal :: (Maybe ScoreT.TypedSignal -> ScoreT.TypedSignal) -> Key -> Environ -> Either Error DeriveT.Val
insert_val :: Typecheck.ToVal a => Key -> a -> Environ -> Environ
data LookupError
- = NotFound
- | WrongType !ValType.Type
get_val :: Typecheck.Typecheck a => Key -> Environ -> Either LookupError a
maybe_val :: Typecheck.Typecheck a => Key -> Environ -> Maybe a
checked_val :: forall a. Typecheck.Typecheck a => Key -> Environ -> Either Text (Maybe a)
checked_val2 :: Typecheck.Typecheck a => Key -> Environ -> Maybe (Either Text a)

Documentation

type Key = Text Source #

Symbols to look up a val in the ValMap.

data Environ Source #

Instances

Instances details

Monoid Environ Source #
Instance details Defined in Derive.DeriveT Methods mempty :: Environ # mappend :: Environ -> Environ -> Environ # mconcat :: [Environ] -> Environ #
Semigroup Environ Source #
Instance details Defined in Derive.DeriveT Methods (<>) :: Environ -> Environ -> Environ # sconcat :: NonEmpty Environ -> Environ # stimes :: Integral b => b -> Environ -> Environ #
Show Environ Source #
Instance details Defined in Derive.DeriveT Methods showsPrec :: Int -> Environ -> ShowS # show :: Environ -> String # showList :: [Environ] -> ShowS #
NFData Environ Source #
Instance details Defined in Derive.DeriveT Methods rnf :: Environ -> () #
Pretty Environ Source #
Instance details Defined in Derive.DeriveT Methods pretty :: Environ -> Text Source # format :: Environ -> Doc Source # formatList :: [Environ] -> Doc Source #

null :: Environ -> Bool Source #

lookup :: Key -> Environ -> Maybe DeriveT.Val Source #

insert :: Key -> DeriveT.Val -> Environ -> Environ Source #

Insert a val directly, with no typechecking.

from_list :: [(Key, DeriveT.Val)] -> Environ Source #

to_list :: Environ -> [(Key, DeriveT.Val)] Source #

to_map :: Environ -> Map Key DeriveT.Val Source #

from_map :: Map Key DeriveT.Val -> Environ Source #

delete :: Key -> Environ -> Environ Source #

is_set :: Key -> Environ -> Bool Source #

map :: (DeriveT.Val -> DeriveT.Val) -> Environ -> Environ Source #

from_controls :: ScoreT.ControlMap -> Environ Source #

put

put_val :: Typecheck.ToVal a => Key -> a -> Environ -> Either Error Environ Source #

Insert a new val, but return Left if it changes the type of an existing one, so once you put a key of a given type into the environ, it can only ever be overwritten by a Val of the same type. The idea is that being inconsistent with types will just lead to confusion.

DeriveT.VNotGiven is another special case, it deletes the given key.

modify_signal :: (Maybe ScoreT.TypedSignal -> ScoreT.TypedSignal) -> Key -> Environ -> Either Error DeriveT.Val Source #

insert_val :: Typecheck.ToVal a => Key -> a -> Environ -> Environ Source #

Insert a val without typechecking.

data LookupError Source #

Constructors

NotFound
WrongType !ValType.Type

Instances

Instances details

Show LookupError Source #
Instance details Defined in Derive.Env Methods showsPrec :: Int -> LookupError -> ShowS # show :: LookupError -> String # showList :: [LookupError] -> ShowS #

get_val :: Typecheck.Typecheck a => Key -> Environ -> Either LookupError a Source #

maybe_val :: Typecheck.Typecheck a => Key -> Environ -> Maybe a Source #

Like get_val, except that type errors and not found both turn into Nothing.

checked_val :: forall a. Typecheck.Typecheck a => Key -> Environ -> Either Text (Maybe a) Source #

Like get_val but format a WrongType nicely.

checked_val2 :: Typecheck.Typecheck a => Key -> Environ -> Maybe (Either Text a) Source #

Like checked_val, but juggle the return type around so NotFound is just Nothing, which is more convenient in some cases.