Snap.Restful

Core API

addResource

Arguments

:: HasHeist b

=> Resource

Resource definition

-> [(CRUD, Handler b v ())]

Standard CRUD handlers

-> [(Text, Handler b v ())]

Additional resource level handlers

-> [(Text, Handler b v ())]

Additional instance/item level handlers

-> Snaplet (Heist b)

The Heist snaplet initialized in your app's Initializer

-> Initializer b v ()

One-stop convenience function to enable RESTful resources in your application. Call this function from your initializer passing it all of your resources and it will add the routes and splices for you.

addResourceRelative

Arguments

:: HasHeist b

=> Resource

Resource definition

-> [(CRUD, Handler b v ())]

Standard CRUD handlers

-> [(Text, Handler b v ())]

Additional resource level handlers

-> [(Text, Handler b v ())]

Additional instance/item level handlers

-> Snaplet (Heist b)

The Heist snaplet initialized in your app's Initializer

-> Initializer b v ()

Just like addResource, but makes the handlers relative to the current snaplet's root. Use this function if you're writing a snaplet.

initRest :: HasHeist b => Resource -> [(CRUD, Handler b () ())] -> [(Text, Handler b () ())] -> [(Text, Handler b () ())] -> Snaplet (Heist b) -> SnapletInit b ()

An initializer for encapsulating RESTful resources as a standalone snaplet.

Splice functions

resourceSplices :: Monad m => Resource -> Splices (HeistT n m Template)

Paths at the resource/collection level

itemSplices :: Monad m => Resource -> DBId -> Splices (Splice m)

Generates path splices for a resource item. These splices let you put resource links in your templates in DRY manner.

resourceCSplices :: MonadSnap m => Resource -> Splices (Splice m)

Returns compiled splices for a resource.

itemCSplices :: Resource -> Splices (Maybe DBId -> Text)

Generates compiled path splices for a resource item. These splices let you put resource links in your templates in DRY manner.

itemCSplice :: forall (n :: Type -> Type). MonadSnap n => Resource -> Splice n

A splice that runs its children with all item splices for a resource. This function gets the id from the "id" param, which could have come in the request or might have been set up by a route capture string.

unitLens :: Lens' b ()

Since initRest returns unit, we provide a generic unit lens here for use with nestSnaplet in case you don't want to add a unit field to your application state type.

resourceRouter :: MonadSnap m => Resource -> [(CRUD, m a)] -> [(Text, m a)] -> [(Text, m a)] -> m a

Generate a route handler for the routes returned by resourceRoutes. This function does add the rRoot prefix.

resourceRoutes :: MonadSnap m => Resource -> [(CRUD, m a)] -> [(Text, m a)] -> [(Text, m a)] -> [(ByteString, m a)]

See addResource for an explanation of the arguments to this function. The routes returned ARE prefixed with rRoot from Resource.

Types

data CRUD

Enumeration of all the different types of CRUD routes.

Constructors

RIndex

An item index

RShow

A single item

RNew

The form for creating a new item

REdit

The form for editing an item

RCreate

Create a new item

RUpdate

Update an item

RDestroy

Delete an item

Instances

Eq CRUD

Defined in Snap.Restful

Methods

(==) :: CRUD -> CRUD -> Bool

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

Ord CRUD

Defined in Snap.Restful

Methods

compare :: CRUD -> CRUD -> Ordering

(<) :: CRUD -> CRUD -> Bool

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

(>) :: CRUD -> CRUD -> Bool

(>=) :: CRUD -> CRUD -> Bool

max :: CRUD -> CRUD -> CRUD

min :: CRUD -> CRUD -> CRUD

Read CRUD

Defined in Snap.Restful

Methods

readsPrec :: Int -> ReadS CRUD

readList :: ReadS [CRUD]

readPrec :: ReadPrec CRUD

readListPrec :: ReadPrec [CRUD]

Show CRUD

Defined in Snap.Restful

Methods

showsPrec :: Int -> CRUD -> ShowS

show :: CRUD -> String

showList :: [CRUD] -> ShowS

data Resource

Encapsulates the data necessary to define a resource.

Constructors

Resource

Fields

• rName :: Text

  A name for this resource

• rRoot :: Text

  URL root for this resource

• rResourceEndpoints :: [Text]

  Resource level routing end points

• rItemEndpoints :: [Text]

  Item/instance level routing end points

Instances

Default Resource

Defined in Snap.Restful

Methods

def :: Resource

newtype DBId

Constructors

DBId

Fields

• unDBId :: Word64

Instances

Eq DBId

Defined in Snap.Restful

Methods

(==) :: DBId -> DBId -> Bool

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

Num DBId

Defined in Snap.Restful

Methods

(+) :: DBId -> DBId -> DBId

(-) :: DBId -> DBId -> DBId

(*) :: DBId -> DBId -> DBId

negate :: DBId -> DBId

abs :: DBId -> DBId

signum :: DBId -> DBId

fromInteger :: Integer -> DBId

Ord DBId

Defined in Snap.Restful

Methods

compare :: DBId -> DBId -> Ordering

(<) :: DBId -> DBId -> Bool

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

(>) :: DBId -> DBId -> Bool

(>=) :: DBId -> DBId -> Bool

max :: DBId -> DBId -> DBId

min :: DBId -> DBId -> DBId

Read DBId

Defined in Snap.Restful

Methods

readsPrec :: Int -> ReadS DBId

readList :: ReadS [DBId]

readPrec :: ReadPrec DBId

readListPrec :: ReadPrec [DBId]

Show DBId

Defined in Snap.Restful

Methods

showsPrec :: Int -> DBId -> ShowS

show :: DBId -> String

showList :: [DBId] -> ShowS

Default DBId

Defined in Snap.Restful

Methods

def :: DBId

Readable DBId

Defined in Snap.Restful

Methods

fromText :: MonadPlus m => Text -> m DBId

fromBS :: MonadPlus m => ByteString -> m DBId

Generating forms and splices

class HasFormlet a where

Type class for automatic formlet generation.

Methods

formlet :: Monad m => Formlet Text m a

Instances

HasFormlet Bool

Defined in Snap.Restful

Methods

formlet :: forall (m :: Type -> Type). Monad m => Formlet Text m Bool

HasFormlet Double

Defined in Snap.Restful

Methods

formlet :: forall (m :: Type -> Type). Monad m => Formlet Text m Double

HasFormlet Float

Defined in Snap.Restful

Methods

formlet :: forall (m :: Type -> Type). Monad m => Formlet Text m Float

HasFormlet Int

Defined in Snap.Restful

Methods

formlet :: forall (m :: Type -> Type). Monad m => Formlet Text m Int

HasFormlet Int8

Defined in Snap.Restful

Methods

formlet :: forall (m :: Type -> Type). Monad m => Formlet Text m Int8

HasFormlet Int16

Defined in Snap.Restful

Methods

formlet :: forall (m :: Type -> Type). Monad m => Formlet Text m Int16

HasFormlet Int32

Defined in Snap.Restful

Methods

formlet :: forall (m :: Type -> Type). Monad m => Formlet Text m Int32

HasFormlet Int64

Defined in Snap.Restful

Methods

formlet :: forall (m :: Type -> Type). Monad m => Formlet Text m Int64

HasFormlet Integer

Defined in Snap.Restful

Methods

formlet :: forall (m :: Type -> Type). Monad m => Formlet Text m Integer

HasFormlet Word8

Defined in Snap.Restful

Methods

formlet :: forall (m :: Type -> Type). Monad m => Formlet Text m Word8

HasFormlet Word16

Defined in Snap.Restful

Methods

formlet :: forall (m :: Type -> Type). Monad m => Formlet Text m Word16

HasFormlet Word32

Defined in Snap.Restful

Methods

formlet :: forall (m :: Type -> Type). Monad m => Formlet Text m Word32

HasFormlet Word64

Defined in Snap.Restful

Methods

formlet :: forall (m :: Type -> Type). Monad m => Formlet Text m Word64

HasFormlet String

Defined in Snap.Restful

Methods

formlet :: forall (m :: Type -> Type). Monad m => Formlet Text m String

HasFormlet ByteString

Defined in Snap.Restful

Methods

formlet :: forall (m :: Type -> Type). Monad m => Formlet Text m ByteString

HasFormlet Text

Defined in Snap.Restful

Methods

formlet :: forall (m :: Type -> Type). Monad m => Formlet Text m Text

class PrimSplice a where

Type class for automatic splice generation.

Methods

iPrimSplice :: Monad m => a -> m [Node]

cPrimSplice :: a -> Builder

Instances

PrimSplice Bool

Defined in Snap.Restful

Methods

iPrimSplice :: Monad m => Bool -> m [Node]

cPrimSplice :: Bool -> Builder

PrimSplice Double

Defined in Snap.Restful

Methods

iPrimSplice :: Monad m => Double -> m [Node]

cPrimSplice :: Double -> Builder

PrimSplice Float

Defined in Snap.Restful

Methods

iPrimSplice :: Monad m => Float -> m [Node]

cPrimSplice :: Float -> Builder

PrimSplice Int

Defined in Snap.Restful

Methods

iPrimSplice :: Monad m => Int -> m [Node]

cPrimSplice :: Int -> Builder

PrimSplice Int8

Defined in Snap.Restful

Methods

iPrimSplice :: Monad m => Int8 -> m [Node]

cPrimSplice :: Int8 -> Builder

PrimSplice Int16

Defined in Snap.Restful

Methods

iPrimSplice :: Monad m => Int16 -> m [Node]

cPrimSplice :: Int16 -> Builder

PrimSplice Int32

Defined in Snap.Restful

Methods

iPrimSplice :: Monad m => Int32 -> m [Node]

cPrimSplice :: Int32 -> Builder

PrimSplice Int64

Defined in Snap.Restful

Methods

iPrimSplice :: Monad m => Int64 -> m [Node]

cPrimSplice :: Int64 -> Builder

PrimSplice Integer

Defined in Snap.Restful

Methods

iPrimSplice :: Monad m => Integer -> m [Node]

cPrimSplice :: Integer -> Builder

PrimSplice Word8

Defined in Snap.Restful

Methods

iPrimSplice :: Monad m => Word8 -> m [Node]

cPrimSplice :: Word8 -> Builder

PrimSplice Word16

Defined in Snap.Restful

Methods

iPrimSplice :: Monad m => Word16 -> m [Node]

cPrimSplice :: Word16 -> Builder

PrimSplice Word32

Defined in Snap.Restful

Methods

iPrimSplice :: Monad m => Word32 -> m [Node]

cPrimSplice :: Word32 -> Builder

PrimSplice Word64

Defined in Snap.Restful

Methods

iPrimSplice :: Monad m => Word64 -> m [Node]

cPrimSplice :: Word64 -> Builder

PrimSplice String

Defined in Snap.Restful

Methods

iPrimSplice :: Monad m => String -> m [Node]

cPrimSplice :: String -> Builder

PrimSplice Text

Defined in Snap.Restful

Methods

iPrimSplice :: Monad m => Text -> m [Node]

cPrimSplice :: Text -> Builder

PrimSplice UTCTime

Defined in Snap.Restful

Methods

iPrimSplice :: Monad m => UTCTime -> m [Node]

cPrimSplice :: UTCTime -> Builder

PrimSplice Day

Defined in Snap.Restful

Methods

iPrimSplice :: Monad m => Day -> m [Node]

cPrimSplice :: Day -> Builder

PrimSplice a => PrimSplice (Maybe a)

Defined in Snap.Restful

Methods

iPrimSplice :: Monad m => Maybe a -> m [Node]

cPrimSplice :: Maybe a -> Builder

iPrimText :: Monad m => Text -> m [Node]

iPrimShow :: (Monad m, Show a) => a -> m [Node]

cPrimShow :: Show a => a -> Builder

Functions for generating paths

rootPath :: Resource -> Text

Same as indexPath.

indexPath :: Resource -> Text

Generates the path for the resource index.

createPath :: Resource -> Text

Generates the path for creating a resource.

showPath :: Resource -> DBId -> Text

Generates the path for showing a single resource item.

newPath :: Resource -> Text

Generates the path for a form to a new resource.

editPath :: Resource -> DBId -> Text

Generates the path for a form to a new resource.

updatePath :: Resource -> DBId -> Text

Generates the path for updating a single resource item.

destroyPath :: Resource -> DBId -> Text

Generates the path for deleting a resource item.

itemActionPath :: Resource -> Text -> DBId -> Text

Generates a path for an item action.

templatePath :: Resource -> CRUD -> ByteString

Return heist template location for given crud action

Misc helpers

redirToItem :: MonadSnap m => Resource -> DBId -> m a

Redirect to given item's default show page

relativeRedirect :: MonadSnap m => ByteString -> m b

setFormAction :: MonadSnap m => Text -> m a -> m a

Sets the RESTFormAction param.

getFormAction :: MonadSnap m => HeistT n m [Node]

Gets the RESTFormAction param.