package mdx

  1. Overview
  2. Docs
Executable code blocks inside markdown files

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (21)

Authors

  1. T
    Thomas Gazagnaire <thomas@gazagnaire.org>

Maintainers

  1. T
    Thomas Gazagnaire <thomas@gazagnaire.org>

Sources

mdx-1.8.0.tbz
sha256=a248a58792c132f5b63982148ad85cc1d531a354cbbdd08156e108d5c6b951dc
sha512=1233893859b0f67a43759ec0c1c795dbbffa40555eb37440ea161dc3f773b8724f368d749a05555687244a62af8036a97357bec86376659d70f3d9d4355496e2

doc/mdx.csexp/Csexp/Make/index.html

Module Csexp.Make

Parameters

module Sexp : Sexp

Signature

Parsing

val parse_string : string -> (Sexp.t, int * string) Result.result

parse_string s parses a single S-expression encoded in canonical form in s. It is an error for s to contain a S-expression followed by more data. In case of error, the offset of the error as well as an error message is returned.

val parse_string_many : string -> (Sexp.t list, int * string) Result.result

parse_string s parses a sequence of S-expressions encoded in canonical form in s

val input : in_channel -> (Sexp.t, string) Result.result

Read exactly one canonical S-expressions from the given channel. Note that this function never raises End_of_file. Instead, it returns Error.

val input_opt : in_channel -> (Sexp.t option, string) Result.result

Same as input but returns Ok None if the end of file has already been reached. If some more characters are available but the end of file is reached before reading a complete S-expression, this function returns Error.

val input_many : in_channel -> (Sexp.t list, string) Result.result

Read many S-expressions until the end of input is reached.

Serialising

val serialised_length : Sexp.t -> int

The length of the serialised representation of a S-expression

val to_string : Sexp.t -> string

to_string sexp converts S-expression sexp to a string in canonical form.

val to_buffer : Buffer.t -> Sexp.t -> unit

to_buffer buf sexp outputs the S-expression sexp converted to its canonical form to buffer buf.

val to_channel : out_channel -> Sexp.t -> unit

output oc sexp outputs the S-expression sexp converted to its canonical form to channel oc.

Low level parser

Low level parsing interface with fine-grain control over the input monad. Suitable for Lwt or Async integration.

module type Input = sig ... end
module Make_parser (Input : Input) : sig ... end