Giter Club home page Giter Club logo

ppx_catch's Introduction

Simple PPX rewriter to catch exceptions and wrap the result into (‘a, string) result

Overview

May be useful to handle the case when the function inside List.map fails:

let%catch func lst =
  List.map (fun x ->
    if x > 0 then failwith "Some problem" else x + 1) lst 

becomes:

let%catch func lst =
  try
    Ok (List.map (fun x ->
      if x > 0 then failwith "Some problem" else x + 1) lst)
  with
  | Failure err -> Error (*[ "func: " + err ]*) (* error messages with tracing *)
    (* and so on *) ...
  | _ -> Error "func: Unknown error" 

Extension handles both top-level and “embedded” let bindings:

let foo =
  let%catch wants_to_raise () = (* wrap some Stdlib function for example *)
    (* some logic *)
    failwith "Stdlib exception" (* call to Stdlib function that raises an exception *)
  in

  wants_to_raise () (* returns ('a, string) result *)

Also works with “function” syntax:

let%catch wrap_function = function
  | Some res -> res
  | None -> failwith "function syntax works too"

It basically wraps each case of the pattern matching.

let () =
  match wrap_function None with
  | Ok ok -> Printf.printf "Ok\n" ;
  | Error err -> Printf.printf "%s\n" err ;
  () 

prints :

wrap_function: function syntax works too

Quickstart

To instal this rewriter as opam package:

git clone https://github.com/slamko/ppx_catch.git &&
cd ppx_catch &&
dune build &&
opam install .

Now to use it in your project add ppx_catch to library list and tell to use it as a preprocessor in your dune file:

(libraries
            ppx_catch)
(preprocess (pps ppx_catch))

For a complete dune file example see test/dune

LICENSE

GPL-v3.0

ppx_catch's People

Contributors

slamko avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.