Anki.Common

Description

Auxiliary functions and types.

Documentation

data AnkiException

The exception is thrown when something goes wrong with this package.

Constructors

WrongFieldType

Thrown when column type is not a text.

NotJson

Thrown when text from database is not a valid json.

WrongJsonFormat

Thrown when json format differs from expected one.

ModelIdInconsistent

Thrown when external and internal ids of model differ.

DeckIdInconsistent

Thrown when external and internal ids of deck differ.

DeckOptionsIdInconsistent

Thrown when external and internal ids of deck options differ.

Instances

Eq AnkiException

Methods

(==) :: AnkiException -> AnkiException -> Bool

(/=) :: AnkiException -> AnkiException -> Bool

Show AnkiException

Methods

showsPrec :: Int -> AnkiException -> ShowS

show :: AnkiException -> String

showList :: [AnkiException] -> ShowS

Exception AnkiException

Methods

toException :: AnkiException -> SomeException

fromException :: SomeException -> Maybe AnkiException

displayException :: AnkiException -> String

newtype WeaklyTypedInt

A wrapper to handle integers and strings with integers.

Constructors

WeaklyTypedInt

Fields

• getInt :: Int

Instances

Eq WeaklyTypedInt

Methods

(==) :: WeaklyTypedInt -> WeaklyTypedInt -> Bool

(/=) :: WeaklyTypedInt -> WeaklyTypedInt -> Bool

Num WeaklyTypedInt

Methods

(+) :: WeaklyTypedInt -> WeaklyTypedInt -> WeaklyTypedInt

(-) :: WeaklyTypedInt -> WeaklyTypedInt -> WeaklyTypedInt

(*) :: WeaklyTypedInt -> WeaklyTypedInt -> WeaklyTypedInt

negate :: WeaklyTypedInt -> WeaklyTypedInt

abs :: WeaklyTypedInt -> WeaklyTypedInt

signum :: WeaklyTypedInt -> WeaklyTypedInt

fromInteger :: Integer -> WeaklyTypedInt

Show WeaklyTypedInt

Methods

showsPrec :: Int -> WeaklyTypedInt -> ShowS

show :: WeaklyTypedInt -> String

showList :: [WeaklyTypedInt] -> ShowS

FromJSON WeaklyTypedInt

Methods

parseJSON :: Value -> Parser WeaklyTypedInt

parseJSONList :: Value -> Parser [WeaklyTypedInt]

FromField WeaklyTypedInt

Methods

fromField :: FieldParser WeaklyTypedInt

newtype WeaklyTypedBool

A wrapper to handle booleans, strings with booleans and 0-1 integers.

Constructors

WeaklyTypedBool

Fields

• getBool :: Bool

Instances

Eq WeaklyTypedBool

Methods

(==) :: WeaklyTypedBool -> WeaklyTypedBool -> Bool

(/=) :: WeaklyTypedBool -> WeaklyTypedBool -> Bool

Show WeaklyTypedBool

Methods

showsPrec :: Int -> WeaklyTypedBool -> ShowS

show :: WeaklyTypedBool -> String

showList :: [WeaklyTypedBool] -> ShowS

FromJSON WeaklyTypedBool

Methods

parseJSON :: Value -> Parser WeaklyTypedBool

parseJSONList :: Value -> Parser [WeaklyTypedBool]

newtype ModificationTime

A wrapper handle time in POSIX format.

Constructors

ModificationTime

Fields

• getModificationTime :: UTCTime

Instances

Eq ModificationTime

Methods

(==) :: ModificationTime -> ModificationTime -> Bool

(/=) :: ModificationTime -> ModificationTime -> Bool

Show ModificationTime

Methods

showsPrec :: Int -> ModificationTime -> ShowS

show :: ModificationTime -> String

showList :: [ModificationTime] -> ShowS

FromJSON ModificationTime

Methods

parseJSON :: Value -> Parser ModificationTime

parseJSONList :: Value -> Parser [ModificationTime]

FromField ModificationTime

Methods

fromField :: FieldParser ModificationTime

throwErr :: Typeable a => Field -> AnkiException -> Ok a

Exit from Ok monad.

getTextValue :: Field -> Ok ByteString

Read field as a byte sequence.

getJsonValue :: Field -> Ok Value

Read field as a JSON.

fromDictionary :: Typeable a => (Field -> (Text, Value) -> Ok a) -> Field -> Value -> Ok [a]

Transform a JSON-dictionary to a list of values.

mkEntry :: (Typeable a, FromJSON a, Eq b, Typeable b, FromJSON b) => (a -> b) -> AnkiException -> Field -> (Text, Value) -> Ok a

Transform a single pair from JSON-dictionary of type { id: {id: id, ....} } to a record.

dropPrefixOptions :: Options

Default options used in Aeson typeclasses in this module.