package cow

You can search for identifiers within the package.

in-package search v0.2.0

package cow

cow
- Cow
- Cow_atom
- Cow_html
  - Create
    
    Tags
- Cow_json
- Cow_markdown
- Cow_xhtml
- Cow_xml
  - Buffer
  - Make
    
    Buffer
    
    String
  - S
  - String

Legend:
Library
Module
Module type
Parameter
Class
Class type

The Atom Syndication format. See RFC4287 for the full specification.

deprecated
Please use the Syndic package instead.

type author = {

name : string;
uri : string option;
email : string option;

}

type date = int * int * int * int * int

year, month, date, hour, minute

val compare : date -> date -> int

type link = {

rel : [ `self | `alternate ];
href : Uri.t;
typ : string option;

}

An Atom URI. There are lots of rules on which combinations of links are permitted in one feed. See RFC4287 Sec 4.1.1 for the gory details.

val mk_link : ?rel:[ `self | `alternate ] -> ?typ:string -> Uri.t -> link

mk_link ~rel ~typ uri builds a link. rel defaults to `self, and typ represents the optional MIME type (e.g. text/html). The uri should usually be a fully qualified URI.

type meta = {

id : string;
title : string;
subtitle : string option;
author : author option;
rights : string option;
updated : date;
links : link list;

}

type summary = string option

A single entry in the Atom feed. The base represents the base href for the contents of the feed, in case it has relative links.

type entry = {

entry : meta;
summary : summary;
content : Cow_xml.t;
base : string option;

}

type feed = {

feed : meta;
entries : entry list;

}

val xml_of_feed : ?self:string -> feed -> Cow_xml.t