http-link-header: A parser and writer for the HTTP Link header per RFC 5988

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Please see the README on GitHub at https://github.com/myfreeweb/http-link-header#readme


[Skip to Readme]

Properties

Versions 0.1.0, 0.2.0, 1.0.0, 1.0.1, 1.0.2, 1.0.3, 1.0.3.1, 1.1.1, 1.1.1, 1.2.0, 1.2.1
Change log None available
Dependencies attoparsec (>=0.13.2.4 && <0.14), base (>=4.3 && <5), bytestring (>=0.10.10.0 && <0.11), errors (>=2.3.0 && <2.4), http-api-data (>=0.4.1.1 && <0.5), network-uri (>=2.6.3.0 && <2.7), text (>=1.2.4.0 && <1.3) [details]
License LicenseRef-PublicDomain
Copyright 2014-2020 Greg V <greg@unrelenting.technology>
Author Greg V
Maintainer stevenjshuck@gmail.com
Category Web
Home page https://github.com/myfreeweb/http-link-header#readme
Bug tracker https://github.com/myfreeweb/http-link-header/issues
Source repo head: git clone https://github.com/myfreeweb/http-link-header
Uploaded by SShuck at 2020-08-27T00:19:19Z

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees


Readme for http-link-header-1.1.1

[back to package description]

http-link-header Hackage Build Status Coverage Status unlicense

A Haskell library than implements a parser and a writer for the HTTP Link header as specified in RFC 5988 "Web Linking".

Usage

import Network.HTTP.Link
import Network.URI
import Data.Maybe

----- Writing
writeLinkHeader [ Link (fromJust $ parseURI "https://example.com/hello%20world") [(Rel, "next"), (Title, "hello world")]
                , Link (fromJust $ parseURI "https://yolo.tld") [(Rel, "license")] ]
-- "<https://example.com/hello%20world>; rel=\"next\"; title=\"hello world\", <https://yolo.tld>; rel=\"license\""

----- Parsing
parseLinkHeader "<https://example.com/2>; rel=\"next\", <https://example.com/0>; rel=prev"
-- Just [ Link https://example.com/2 [(Rel, "next")]
--      , Link https://example.com/0 [(Rel, "prev")] ]

Development

Use stack to build.
Use ghci to run tests quickly with :test (see the .ghci file).

$ stack build

$ stack test && rm tests.tix

$ stack bench

$ stack ghci --ghc-options="-fno-hpc"

Contributing

Please feel free to submit pull requests! Bugfixes and simple non-breaking improvements will be accepted without any questions :-)

By participating in this project you agree to follow the Contributor Code of Conduct.

The list of contributors is available on GitHub.

License

This is free and unencumbered software released into the public domain.
For more information, please refer to the UNLICENSE file or unlicense.org.