package volgo

  1. Overview
  2. Docs
package volgo
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Validated_string.MakeSource

Make returns an interface that exposes the fact that t = string so this equality can be used by other functions in the implementation. However, the expected pattern is that such equality is hidden by the inclusion of S in the mli of a validated string. See Author for an example.

Parameters

module _ : X

Signature

Sourceval to_string : string -> string

Given that t = string in the implementation, this function is just the identity.

Sourceval of_string : string -> (string, [ `Msg of string ]) Result.t

of_string str returns Ok str if X.invariant str = true, and an error otherwise. This is meant to be used to validate untrusted entries.

Sourceval v : string -> string

v str is a convenient wrapper to build a t or raise Invalid_argument. This is typically handy for applying on trusted literals.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct