syndic 1.1 · OCaml Package

module Error : sig ... end

type text_construct =

| Text of string
| Html of string
| Xhtml of Syndic_xml.t list

type author = {

name : string;
uri : Uri.t option;
email : string option;

}

type category = {

term : string;
scheme : Uri.t option;
label : string option;

}

type generator = {

version : string option;
uri : Uri.t option;
content : string;

}

type icon = Uri.t

type id = string

type rel =

| Alternate
| Related
| Self
| Enclosure
| Via
| Link of Uri.t

type link = {

href : Uri.t;
rel : rel;
type_media : string option;
hreflang : string option;
title : string option;
length : int option;

}

type logo = Uri.t

type published = CalendarLib.Calendar.t

type rights = text_construct

type title = text_construct

type subtitle = text_construct

type updated = CalendarLib.Calendar.t

type source = {

authors : author * author list;
categories : category list;
contributors : author list;
generator : generator option;
icon : icon option;
id : id;
links : link list;
logo : logo option;
rights : rights option;
subtitle : subtitle option;
title : title;
updated : updated option;

}

type mime = string

type content =

| Text of string
| Html of string
| Xhtml of Syndic_xml.t list
| Mime of mime * string
| Src of mime option * Uri.t

type summary = text_construct

type entry = {

authors : author * author list;
categories : category list;
content : content option;
contributors : author list;
id : id;
links : link list;
published : published option;
rights : rights option;
sources : source list;
summary : summary option;
title : title;
updated : updated;

}

type feed = {

authors : author list;
categories : category list;
contributors : author list;
generator : generator option;
icon : icon option;
id : id;
links : link list;
logo : logo option;
rights : rights option;
subtitle : subtitle option;
title : title;
updated : updated;
entries : entry list;

}

val parse : Xmlm.input -> feed

val to_xml : feed -> Syndic_xml.t

val output : feed -> Xmlm.dest -> unit

val aggregate : 
  ?id:id ->
  ?updated:updated ->
  ?subtitle:subtitle ->
  ?title:text_construct ->
  (Uri.t option * feed) list ->
  feed

val unsafe : 
  Xmlm.input ->
  [> `Feed of
       [> `Author of
            [> `Email of string | `Name of string | `URI of string ] list
       | `Category of
         [> `Label of string | `Scheme of string | `Term of string ] list
       | `Contributor of
         [> `Email of string | `Name of string | `URI of string ] list
       | `Entry of
         [> `Author of
              [> `Email of string | `Name of string | `URI of string ] list
         | `Category of
           [> `Label of string | `Scheme of string | `Term of string ] list
         | `Content of
           [> `Data of Syndic_xml.t list | `SRC of string | `Type of string ]
             list
         | `Contributor of
           [> `Email of string | `Name of string | `URI of string ] list
         | `ID of [> `Data of string ] list
         | `Link of
           [> `HREF of string
           | `HREFLang of string
           | `Length of string
           | `Rel of string
           | `Title of string
           | `Type of string ]
             list
         | `Published of [> `Date of string ] list
         | `Rights of [> `Data of Syndic_xml.t list ]
         | `Source of
           [> `Author of
                [> `Email of string | `Name of string | `URI of string ] list
           | `Category of
             [> `Label of string | `Scheme of string | `Term of string ] list
           | `Contributor of
             [> `Email of string | `Name of string | `URI of string ] list
           | `Generator of
             [> `Content of string | `URI of string | `Version of string ] list
           | `ID of [> `Data of string ] list
           | `Icon of [> `URI of string ] list
           | `Link of
             [> `HREF of string
             | `HREFLang of string
             | `Length of string
             | `Rel of string
             | `Title of string
             | `Type of string ]
               list
           | `Logo of [> `URI of string ] list
           | `Rights of [> `Data of Syndic_xml.t list ]
           | `Subtitle of [> `Data of Syndic_xml.t list ]
           | `Title of [> `Data of Syndic_xml.t list ]
           | `Updated of [> `Date of string ] list ]
             list
         | `Summary of [> `Data of Syndic_xml.t list ]
         | `Title of [> `Data of Syndic_xml.t list ]
         | `Updated of [> `Date of string ] list ]
           list
       | `Generator of
         [> `Content of string | `URI of string | `Version of string ] list
       | `ID of [> `Data of string ] list
       | `Icon of [> `URI of string ] list
       | `Link of
         [> `HREF of string
         | `HREFLang of string
         | `Length of string
         | `Rel of string
         | `Title of string
         | `Type of string ]
           list
       | `Logo of [> `URI of string ] list
       | `Rights of [> `Data of Syndic_xml.t list ]
       | `Subtitle of [> `Data of Syndic_xml.t list ]
       | `Title of [> `Data of Syndic_xml.t list ]
       | `Updated of [> `Date of string ] list ]
         list ]

package syndic