Web.Sprinkles.Backends.Data

Types for and operations on backend data.

Documentation

data BackendData p m h

A parsed record from a query result.

Constructors

BackendData

Fields

• bdJSON :: Value

  Result body as JSON

• bdGVal :: GVal (Run p m h)

  Result body as GVal

• bdRaw :: RawBytes

  Raw result body source

• bdMeta :: BackendMeta

  Meta-information

• bdChildren :: HashMap Text (BackendData p m h)

  Child documents

• bdVerification :: Verification

Instances

ToJSON (BackendData p m h)

Defined in Web.Sprinkles.Backends.Data

Methods

toJSON :: BackendData p m h -> Value

toEncoding :: BackendData p m h -> Encoding

toJSONList :: [BackendData p m h] -> Value

toEncodingList :: [BackendData p m h] -> Encoding

MonadIO m => ToGVal (Run p m h) (BackendData p m h)

Defined in Web.Sprinkles.Backends.Data

Methods

toGVal :: BackendData p m h -> GVal (Run p m h)

data BackendMeta

Metadata for a backend query result.

Constructors

BackendMeta

Fields

• bmMimeType :: MimeType
• bmMTime :: Maybe POSIXTime

  Last modification time, if available

• bmName :: Text

  Human-friendly name

• bmPath :: Text

  Path, according to the semantics of the backend (file path or URI)

• bmSize :: Maybe Integer

  Size of the raw source, in bytes, if available

Instances

Show BackendMeta

Defined in Web.Sprinkles.Backends.Data

Methods

showsPrec :: Int -> BackendMeta -> ShowS

show :: BackendMeta -> String

showList :: [BackendMeta] -> ShowS

Generic BackendMeta

Defined in Web.Sprinkles.Backends.Data

Associated Types

type Rep BackendMeta :: * -> *

Methods

from :: BackendMeta -> Rep BackendMeta x

to :: Rep BackendMeta x -> BackendMeta

ToJSON BackendMeta

Defined in Web.Sprinkles.Backends.Data

Methods

toJSON :: BackendMeta -> Value

toEncoding :: BackendMeta -> Encoding

toJSONList :: [BackendMeta] -> Value

toEncodingList :: [BackendMeta] -> Encoding

Serialize BackendMeta

Defined in Web.Sprinkles.Backends.Data

Methods

put :: Putter BackendMeta

get :: Get BackendMeta

ToGVal m BackendMeta

Defined in Web.Sprinkles.Backends.Data

Methods

toGVal :: BackendMeta -> GVal m

type Rep BackendMeta

Defined in Web.Sprinkles.Backends.Data

type Rep BackendMeta = D1 (MetaData "BackendMeta" "Web.Sprinkles.Backends.Data" "sprinkles-0.6.0.0-EffGjOzp9OR7TO7a15Us7S" False) (C1 (MetaCons "BackendMeta" PrefixI True) ((S1 (MetaSel (Just "bmMimeType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MimeType) :*: S1 (MetaSel (Just "bmMTime") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe POSIXTime))) :*: (S1 (MetaSel (Just "bmName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: (S1 (MetaSel (Just "bmPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "bmSize") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Integer))))))

data BackendSource

A raw (unparsed) record from a query result.

Constructors

BackendSource

Fields

• bsMeta :: BackendMeta
• bsSource :: RawBytes
• bsVerification :: Verification

Instances

Generic BackendSource

Defined in Web.Sprinkles.Backends.Data

Associated Types

type Rep BackendSource :: * -> *

Methods

from :: BackendSource -> Rep BackendSource x

to :: Rep BackendSource x -> BackendSource

type Rep BackendSource

Defined in Web.Sprinkles.Backends.Data

type Rep BackendSource = D1 (MetaData "BackendSource" "Web.Sprinkles.Backends.Data" "sprinkles-0.6.0.0-EffGjOzp9OR7TO7a15Us7S" False) (C1 (MetaCons "BackendSource" PrefixI True) (S1 (MetaSel (Just "bsMeta") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 BackendMeta) :*: (S1 (MetaSel (Just "bsSource") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RawBytes) :*: S1 (MetaSel (Just "bsVerification") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Verification))))

data Verification

Constructors

Trusted

VerifyCSRF

Instances

Bounded Verification

Defined in Web.Sprinkles.Backends.Data

Methods

minBound :: Verification

maxBound :: Verification

Enum Verification

Defined in Web.Sprinkles.Backends.Data

Methods

succ :: Verification -> Verification

pred :: Verification -> Verification

toEnum :: Int -> Verification

fromEnum :: Verification -> Int

enumFrom :: Verification -> [Verification]

enumFromThen :: Verification -> Verification -> [Verification]

enumFromTo :: Verification -> Verification -> [Verification]

enumFromThenTo :: Verification -> Verification -> Verification -> [Verification]

Eq Verification

Defined in Web.Sprinkles.Backends.Data

Methods

(==) :: Verification -> Verification -> Bool

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

Ord Verification

Defined in Web.Sprinkles.Backends.Data

Methods

compare :: Verification -> Verification -> Ordering

(<) :: Verification -> Verification -> Bool

(<=) :: Verification -> Verification -> Bool

(>) :: Verification -> Verification -> Bool

(>=) :: Verification -> Verification -> Bool

max :: Verification -> Verification -> Verification

min :: Verification -> Verification -> Verification

Show Verification

Defined in Web.Sprinkles.Backends.Data

Methods

showsPrec :: Int -> Verification -> ShowS

show :: Verification -> String

showList :: [Verification] -> ShowS

data RawBytes

Constructors

RawBytes

Fields

• rbLength :: IO Integer
• rbGetRange :: Integer -> Integer -> IO LByteString

Instances

MonadIO m => ToGVal (Run p m h) RawBytes

Defined in Web.Sprinkles.Backends.Data

Methods

toGVal :: RawBytes -> GVal (Run p m h)

toBackendData :: (ToJSON a, ToGVal (Run p m h) a) => BackendSource -> a -> BackendData p m h

Wrap a parsed backend value in a BackendData structure. The original raw BackendSource value is needed alongside the parsed value, because the resulting structure contains both the BackendMeta and the raw (unparsed) data from it.

data Items a

The shapes of data that can be returned from a backend query.

Constructors

NotFound

Nothing was found

SingleItem a

A single item was requested, and this is it

MultiItem [a]

Multiple items were requested, here they are

Instances

Functor Items

Defined in Web.Sprinkles.Backends.Data

Methods

fmap :: (a -> b) -> Items a -> Items b

(<$) :: a -> Items b -> Items a

Foldable Items

Defined in Web.Sprinkles.Backends.Data

Methods

fold :: Monoid m => Items m -> m

foldMap :: Monoid m => (a -> m) -> Items a -> m

foldr :: (a -> b -> b) -> b -> Items a -> b

foldr' :: (a -> b -> b) -> b -> Items a -> b

foldl :: (b -> a -> b) -> b -> Items a -> b

foldl' :: (b -> a -> b) -> b -> Items a -> b

foldr1 :: (a -> a -> a) -> Items a -> a

foldl1 :: (a -> a -> a) -> Items a -> a

toList :: Items a -> [a]

null :: Items a -> Bool

length :: Items a -> Int

elem :: Eq a => a -> Items a -> Bool

maximum :: Ord a => Items a -> a

minimum :: Ord a => Items a -> a

sum :: Num a => Items a -> a

product :: Num a => Items a -> a

ToGVal m a => ToGVal m (Items a)

Defined in Web.Sprinkles.Backends.Data

Methods

toGVal :: Items a -> GVal m

ToJSON a => ToJSON (Items a)

Defined in Web.Sprinkles.Backends.Data

Methods

toJSON :: Items a -> Value

toEncoding :: Items a -> Encoding

toJSONList :: [Items a] -> Value

toEncodingList :: [Items a] -> Encoding

reduceItems :: FetchMode -> [a] -> Items a

Transform a raw list of results into an Items value. This allows us later to distinguish between Nothing Found vs. Empty List, and between Single Item Requested And Found vs. Many Items Requested, One Found. This is needed such that when a single item is requested, it gets converted to GVal and JSON as a scalar, while when we request many items and receive one, it becomes a singleton list.

addBackendDataChildren :: HashMap Text (BackendData p m h) -> BackendData p m h -> BackendData p m h

rawToLBS :: RawBytes -> IO LByteString

rawFromLBS :: LByteString -> RawBytes

serializeBackendSource :: BackendSource -> IO SerializableBackendSource

deserializeBackendSource :: SerializableBackendSource -> BackendSource