package yaml

You can search for identifiers within the package.

in-package search v0.2.0

yaml
- Yaml
  - Stream
    
    Event
    
    Mark
  - Util
yaml.bindings
- Yaml_bindings
  - M
    
    C
    
    F
yaml.bindings.types
- Yaml_bindings_types
  - Encoding
  - Error
  - Event_type
  - M
    
    Emitter
    
    Event
    
    Alias
    
    Data
    
    Document_end
    
    Document_start
    
    Tag_directives
    
    Mapping_start
    
    Scalar
    
    Sequence_start
    
    Stream_start
    
    F
    
    Intptr
    
    Infix
    
    Ptrdiff
    
    Infix
    
    Uintptr
    
    Infix
    
    Mark
    
    Parser
    
    Tag_directive
    
    Token
    
    Alias
    
    Anchor
    
    Data
    
    Scalar
    
    Stream_start
    
    Version
    
    Version_directive
  - Mapping_style
  - Scalar_style
  - Sequence_style
  - Token_type
yaml.c
- Yaml_c
yaml.ffi
- Yaml_ffi
  - G
  - M
    
    C
yaml.types
- Yaml_types
  - G
  - M
    
    Emitter
    
    Event
    
    Alias
    
    Data
    
    Document_end
    
    Document_start
    
    Tag_directives
    
    Mapping_start
    
    Scalar
    
    Sequence_start
    
    Stream_start
    
    Mark
    
    Parser
    
    Tag_directive
    
    Token
    
    Alias
    
    Anchor
    
    Data
    
    Scalar
    
    Stream_start
    
    Version
    
    Version_directive
yaml.unix
- Yaml_unix

Legend:
Library
Module
Module type
Parameter
Class
Class type

UNIX interface functions for handling Yaml

val of_file : Fpath.t -> (Yaml.value, [ `Msg of string ]) result

of_file p will read the whole of the file at path p and convert it in a Yaml.value.

val of_file_exn : Fpath.t -> Yaml.value

of_file_exn p acts as of_file, but errors are thrown as a Failure exception instead of in the return value.

val to_file : Fpath.t -> Yaml.value -> (unit, [ `Msg of string ]) result

to_file p v will convert the Yaml value v to a string and write it to the file at path p.

val to_file_exn : Fpath.t -> Yaml.value -> unit

to_file_exn p acts as to_file, but errors are thrown as a Failure exception instead of in the return value.