package opam-format

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Urls for OPAM repositories

package opam-format

opam-format
- OpamFile
  - Aliases
  - BestEffortRead
  - Changes
  - Comp
  - Config
    
    BestEffort
  - Descr
  - Dot_config
  - Dot_install
  - Environment
  - File_attributes
  - IO_FILE
  - InitConfig
  - LegacyState
  - Lines
  - OPAM
  - Package_index
  - Pinned_legacy
  - PkgList
  - Repo
  - Repo_config_legacy
  - Repos_config
    
    BestEffort
  - Stats
  - SwitchExport
  - SwitchSelections
    
    BestEffort
  - Switch_config
    
    BestEffort
  - Syntax
  - URL
  - Wrappers
- OpamFilter
- OpamFormat
  - I
  - V
- OpamFormatConfig
  - E
- OpamFormula
- OpamInterpLexer
- OpamLineLexer
- OpamPackage
  - Graph
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
    
    Topological
    
    V
  - Map
  - Name
    
    Map
    
    Set
    
    Op
  - Set
    
    Op
  - Version
    
    Map
    
    Set
    
    Op
- OpamPath
  - Builddir
  - LAYOUT
  - Switch
    
    Default
    
    DefaultF
    
    L
    
    Overlay
- OpamPp
  - Op
  - STR
- OpamRepositoryName
  - Map
  - Set
    
    Op
- OpamSwitch
  - Map
  - Set
    
    Op
- OpamSysPkg
  - Map
  - Set
    
    Op
- OpamTypesBase
- OpamVariable
  - Full
    
    Map
    
    Set
    
    Op
  - Map
  - Set
    
    Op

Legend:
Library
Module
Module type
Parameter
Class
Class type

Urls for OPAM repositories

include IO_FILE

type t

File contents

val format_version : OpamVersion.t

val empty : t

Empty file

val write : t typed_file -> t -> unit

Write some contents to a file

val read : t typed_file -> t

Read file contents. Raise an error if the file does not exist.

val read_opt : t typed_file -> t option

Returns None on non-existing file

val safe_read : t typed_file -> t

Read file contents. Return empty if the file does not exist.

val read_from_channel : ?filename:t typed_file -> in_channel -> t

val read_from_string : ?filename:t typed_file -> string -> t

val write_to_channel : ?filename:t typed_file -> out_channel -> t -> unit

val write_to_string : ?filename:t typed_file -> t -> string

val create : 
  ?mirrors:OpamTypes.url list ->
  ?checksum:OpamHash.t list ->
  ?swhid:OpamSWHID.t ->
  ?subpath:OpamTypes.subpath ->
  OpamTypes.url ->
  t

val url : t -> OpamTypes.url

URL address

val mirrors : t -> OpamTypes.url list

val checksum : t -> OpamHash.t list

Archive checksum

val swhid : t -> OpamSWHID.t option

val with_url : OpamTypes.url -> t -> t

Constructor

val with_checksum : OpamHash.t list -> t -> t

val with_mirrors : OpamUrl.t list -> t -> t

val with_swhid : OpamSWHID.t -> t -> t

val with_swhid_opt : OpamSWHID.t option -> t -> t

val with_subpath : OpamTypes.subpath -> t -> t

val with_subpath_opt : OpamTypes.subpath option -> t -> t

val subpath : t -> OpamTypes.subpath option