package stdune

You can search for identifiers within the package.

in-package search v0.2.0

package stdune

stdune
- Stdune
  - Ansi_color
    
    RGB24
    
    RGB8
    
    Style
  - Appendable_list
  - Applicative
    
    Basic
    
    Id
    
    O
    
    Make
    
    A
    
    O
    
    O
  - Array
    
    Floatarray
    
    Immutable
  - Bin
  - Bit_set
    
    Make
    
    Element
  - Bool
  - Bytes
  - Bytes_unit
  - Caller_id
  - Char
  - Code_error
  - Comparable
    
    Make
    
    Key
    
    Map
    
    Multi
    
    Set
  - Comparable_intf
    
    S
    
    Map
    
    Multi
    
    Set
  - Comparator
    
    OPS
    
    Operators
    
    X
    
    S
  - Dev_null
  - Either
  - Env
    
    Map
    
    Multi
    
    Set
    
    Var
    
    Map
    
    Multi
    
    Set
  - Env_path
  - Exn
  - Exn_with_backtrace
  - Fdecl
  - File_kind
  - Filename
    
    Extension
  - Filename_set
  - Float
  - For_tests
    
    Compact_position
    
    For_tests
    
    Same_line_loc
  - Fpath
  - Hashtbl
    
    Make
    
    Key
    
    S
  - Id
    
    Make
    
    Map
    
    Multi
    
    Set
    
    Table
    
    S
    
    Map
    
    Multi
    
    Set
    
    Table
  - Int
    
    Infix
    
    Map
    
    Multi
    
    Set
  - Io
    
    String_path
  - Lexbuf
    
    Loc
    
    Position
  - List
  - Loc
    
    Map
    
    Multi
  - Map
    
    Key
    
    Make
    
    Key
    
    Multi
    
    S
    
    Multi
  - Monad
    
    Basic
    
    Id
    
    O
    
    List
    
    M
    
    O
    
    Make
    
    M
    
    O
    
    O
    
    Option
    
    M
    
    O
    
    Result
    
    M
    
    O
    
    S
    
    O
  - Monoid
    
    Add
    
    M
    
    O
    
    Appendable_list
    
    M
    
    O
    
    Basic
    
    Commutative
    
    Add
    
    M
    
    O
    
    Basic
    
    Exists
    
    O
    
    Forall
    
    O
    
    Function
    
    A
    
    M
    
    O
    
    Make
    
    M
    
    O
    
    Mul
    
    M
    
    O
    
    Product
    
    A
    
    B
    
    O
    
    Product3
    
    A
    
    B
    
    C
    
    O
    
    S
    
    O
    
    Union
    
    M
    
    O
    
    Unit
    
    O
    
    Endofunction
    
    Left
    
    A
    
    O
    
    Right
    
    A
    
    O
    
    Exists
    
    O
    
    Forall
    
    O
    
    Function
    
    A
    
    M
    
    O
    
    List
    
    M
    
    O
    
    Make
    
    M
    
    O
    
    Mul
    
    M
    
    O
    
    O
    
    Product
    
    A
    
    B
    
    O
    
    Product3
    
    A
    
    B
    
    C
    
    O
    
    S
    
    O
    
    String
    
    O
    
    Union
    
    M
    
    O
    
    Unit
    
    O
  - Nonempty_list
  - Nothing
  - Option
    
    List
    
    O
    
    Unboxed
  - Or_exn
    
    O
  - Path
    
    Build
    
    L
    
    Map
    
    Multi
    
    Set
    
    Table
    
    Expert
    
    External
    
    Map
    
    Multi
    
    Set
    
    Table
    
    L
    
    Local
    
    L
    
    Map
    
    Multi
    
    Set
    
    Local_gen
    
    Fix_root
    
    Map
    
    Multi
    
    Root
    
    Set
    
    Table
    
    L
    
    Map
    
    Multi
    
    Outside_build_dir
    
    Table
    
    Permissions
    
    Set
    
    Source
    
    L
    
    Map
    
    Multi
    
    Set
    
    Table
    
    Table
    
    Unspecified
  - Per_item
    
    Make
    
    Key
    
    Make_monad_traversals
    
    Monad
    
    O
    
    Make_monad_traversals
    
    Monad
    
    O
  - Pid
  - Platform
    
    OS
  - Poly
  - Pp
  - Predicate
  - Proc
    
    Process_info
    
    Resource_usage
    
    Times
  - Queue
  - Result
    
    List
    
    O
    
    Option
  - Scanf
  - Seq
  - Set
    
    Make
    
    Key
    
    M
    
    Multi
    
    Of_map
    
    Key
    
    M
    
    Multi
    
    S
  - Sexp
  - Signal
  - Staged
  - State
    
    Make
    
    M
    
    O
    
    O
    
    S
  - String
    
    Caseless
    
    Map
    
    Multi
    
    Set
    
    Table
  - String_builder
  - Sys
  - Table
    
    Key
    
    Multi
  - Temp
    
    Monad
    
    M
  - Top_closure
    
    Int
    
    Make
    
    Keys
    
    Monad
    
    O
    
    String
  - Tuple
    
    T2
    
    T3
  - Type_eq
    
    Id
  - Unit
  - Univ_map
    
    Key
    
    Make
    
    Info
    
    Key
    
    S
    
    Key
  - Unix_error
    
    Detailed
  - User_error
  - User_message
    
    Annots
    
    Key
    
    Print_config
    
    Style
  - User_warning
stdune.filesystem_stubs
- Dune_filesystem_stubs
  - File_kind
  - Unix_error
    
    Detailed

Legend:
Library
Module
Module type
Parameter
Class
Class type

IO operations.

val close_in : Stdlib.in_channel -> unit

val close_out : Stdlib.out_channel -> unit

val close_both : (Stdlib.in_channel * Stdlib.out_channel) -> unit

val input_lines : Stdlib.in_channel -> string list

val copy_channels : Stdlib.in_channel -> Stdlib.out_channel -> unit

This function is not safe to use from multiple threads, even if operating on unrelated channels because it uses a statically-allocated global buffer.

val read_all_unless_large : Stdlib.in_channel -> (string, unit) Stdlib.result

Try to read everything from a channel. Returns Error () if the contents are larger than Sys.max_string_length. This is generally a problem only on 32-bit systems. Overflow detection does not happen in the following cases:

channel is not a file (for example, a pipe)
if the detected size is unreliable (/proc)
race condition with another process changing the size of the underlying file. In these cases, an exception might be raised by Buffer functions.

type path = Path.t

val open_in : ?binary:bool -> path -> Stdlib.in_channel

val open_out : ?binary:bool -> ?perm:int -> path -> Stdlib.out_channel

val with_file_in : ?binary:bool -> path -> f:(Stdlib.in_channel -> 'a) -> 'a

val with_file_out : 
  ?binary:bool ->
  ?perm:int ->
  path ->
  f:(Stdlib.out_channel -> 'a) ->
  'a

val with_lexbuf_from_file : path -> f:(Stdlib.Lexing.lexbuf -> 'a) -> 'a

val lines_of_file : path -> string list

val zero_strings_of_file : path -> string list

Reads zero-separated strings from a file

val read_file : ?binary:bool -> path -> string

val write_file : ?binary:bool -> ?perm:int -> path -> string -> unit

val compare_files : path -> path -> Ordering.t

val compare_text_files : path -> path -> Ordering.t

val write_lines : ?binary:bool -> ?perm:int -> path -> string list -> unit

val copy_file : ?chmod:(int -> int) -> src:path -> dst:path -> unit -> unit

val setup_copy : 
  ?chmod:(int -> int) ->
  src:path ->
  dst:path ->
  unit ->
  Stdlib.in_channel * Stdlib.out_channel

val file_line : path -> int -> string

val file_lines : path -> start:int -> stop:int -> (string * string) list

val cat : ?binary:bool -> ?dst:Stdlib.out_channel -> path -> unit

reads a file and prints its contents to stdout or the specified channel

module String_path : sig ... end

val portable_symlink : src:Path.t -> dst:Path.t -> unit

Symlink with fallback to copy on systems that don't support it.

val portable_hardlink : src:Path.t -> dst:Path.t -> unit

Hardlink with fallback to copy on systems that don't support it.

val set_copy_impl : [ `Portable | `Best ] -> unit