package obuilder

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Creating logs
Reading logs

package obuilder

obuilder
- Obuilder
  - BUILDER
  - Btrfs_store
  - Build_log
  - Builder
    
    Sandbox
    
    Store
    
    _
  - Config
    
    Mount
    
    Secret
  - Context
  - Docker
  - Rsync_store
  - S
    
    BUILDER
    
    FETCHER
    
    SANDBOX
    
    STORE
  - Sandbox
  - Store_spec
  - User_temp
  - Zfs_store

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

The log for a single build step.

Creating logs

val create : string -> t Lwt.t

create path creates a new log file at temporary location path. Call finish when done to release the file descriptor.

val finish : t -> unit Lwt.t

finish t marks log t as finished. If it was open for writing, this closes the file descriptor. It cannot be used after this (for reading or writing), although existing background operations (e.g. tail) can continue successfully.

val write : t -> string -> unit Lwt.t

write t data appends data to the log.

val printf : 
  t ->
  ('a, Stdlib.Format.formatter, unit, unit Lwt.t) Stdlib.format4 ->
  'a

printf t fmt is a wrapper for write t that takes a format string.

Reading logs

val empty : t

empty is a read-only log with no content.

val of_saved : string -> t Lwt.t

of_saved path is a read-only log which reads from path.

val tail : 
  ?switch:Lwt_switch.t ->
  t ->
  (string -> unit) ->
  (unit, [> `Cancelled ]) Lwt_result.t

tail t dst streams data from the log to dst. This can be called at any time before finish is called.

parameter switch
Abort if this is turned off.

val copy : src:Lwt_unix.file_descr -> dst:t -> unit Lwt.t

copy ~src ~dst reads bytes from the src file descriptor and writes them to the build log dst.