The pinch package

[ Tags: bsd3, development, library ] [ Propose Tags ]

This library provides machinery for types to specify how they can be serialized and deserialized into/from Thrift payloads. It makes no assumptions on how these payloads are sent or received and performs no code generation. Types may specify how to be serialized and deserialized by defining instances of the Pinchable typeclass by hand, or with automatically derived instances by using generics. Check the documentation in the Pinch module for more information.

What is Thrift? Apache Thrift provides an interface description language, a set of communication protocols, and a code generator and libraries for various programming languages to interact with the generated code. Pinch aims to provide an alternative implementation of Thrift for Haskell.


[Skip to Readme]

Properties

Versions 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.2.0.0, 0.2.0.1, 0.2.0.2, 0.3.0.0, 0.3.0.1, 0.3.0.2, 0.3.1.0, 0.3.2.0 (info)
Change log CHANGES.md
Dependencies array (>=0.5), base (>=4.7 && <5), bytestring (==0.10.*), containers (==0.5.*), deepseq (>=1.3 && <1.5), ghc-prim, hashable (==1.2.*), text (==1.2.*), unordered-containers (==0.2.*), vector (>=0.10 && <0.13) [details]
License BSD3
Author Abhinav Gupta
Maintainer mail@abhinavg.net
Category Development
Home page https://github.com/abhinav/pinch#readme
Bug tracker https://github.com/abhinav/pinch/issues
Source repository head: git clone https://github.com/abhinav/pinch
Uploaded Sat Jun 3 21:34:43 UTC 2017 by abhinav
Distributions LTSHaskell:0.3.2.0, NixOS:0.3.2.0, Stackage:0.3.2.0, Tumbleweed:0.3.2.0
Downloads 736 total (30 in the last 30 days)
Rating 0.0 (0 ratings) [clear rating]
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-06-03 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for pinch-0.3.2.0

[back to package description]

build-status

pinch aims to provide an alternative implementation of Apache Thrift for Haskell. The pinch library itself acts only as a serialization library. Types specify their Thrift encoding by defining instances of the Pinchable typeclass, which may be done by hand or automatically with the use of Generics.

Haddock documentation for this package is avilable on Hackage and here.

Overview

Types which can be encoded into Thrift payloads implement the Pinchable typeclass.

Given the Thrift struct,

struct Person {
    1: required string name
    2: optional i64 dateOfBirth
}

You can write a Pinchable instance like so,

data Person = Person { name :: Text, dateOfBirth :: Maybe Int64 }
    deriving (Eq)

instance Pinchable Person where
    type Tag Person = TStruct
    -- The Tag tells the system that this represents a struct.

    pinch (Person name dateOfBirth) =
        struct [1 .= name, 2 ?= dateOfBirth]

    unpinch value =
        Person <$> value .:  1
               <*> value .:? 2

Better yet, you can drive an instance automatically.

{-# LANGUAGE DeriveGeneric, DataKinds #-}
import GHC.Generics (Generic)

data Person = Person
    { name        :: Field 1 Text
    , dateOfBirth :: Field 2 (Maybe Int64)
    } deriving (Eq, Generic)

instance Pinchable Person

Objects can be serialized and deserialized using the encode and decode methods. These methods accept a Protocol as an argument.

decode binaryProtocol (encode binaryProtocol person) == person

For more information, check the documentation and the examples.

Supported Protocols

The following Thrift protocols are supported:

  • Binary
  • Compact

Caveats

  • There is no code generation or template haskell support yet so types from the Thrift file will have to be translated by hand.