package datakit-ci

You can search for identifiers within the package.

in-package search v0.2.0

package datakit-ci

datakit-ci
- CI_ACL
- CI_cache
  - Make
    
    B
    
    Key
  - Path
- CI_char_stream
- CI_config
- CI_docker
  - Image
- CI_engine
- CI_escape_parser
- CI_eval
  - Make
    
    C
    
    Infix
- CI_form
  - Html
  - State
  - Validator
- CI_git
  - Commit
- CI_history
  - State
- CI_live_log
- CI_log_reporter
- CI_main
- CI_monitored_pool
- CI_output
- CI_process
- CI_result
- CI_s
  - BUILDER
    
    Key
  - CONTEXT
  - TERM
    
    Infix
- CI_secrets
- CI_static
- CI_target
  - Branch_escape
  - Map
  - Set
- CI_term
  - Infix
- CI_utils
  - Client9p
    
    LowLevel
  - DK
    
    Branch
    
    Commit
    
    Infix
    
    Transaction
    
    Tree
  - Infix
  - Log
- CI_web
- CI_web_templates
  - Error
  - Settings
- CI_web_utils
  - Auth
  - Session_data
  - User
  - Wm
    
    resource
  - auth_intro
  - auth_setup
  - form_page
  - github_auth_settings
  - github_callback
  - html_page
  - login_page
  - logout_page
  - post_page
  - protected_page
  - resource
  - resource_with_session
  - static
  - static_crunch
- Datakit_ci
  - ACL
  - BUILDER
    
    Key
  - Cache
    
    Make
    
    B
    
    Key
    
    Path
  - Config
  - DK
    
    Branch
    
    Commit
    
    Infix
    
    Transaction
    
    Tree
  - Docker
    
    Image
  - Git
  - Live_log
  - Monitored_pool
  - Output
  - Private
    
    Client9p
    
    LowLevel
  - Process
  - Target
  - Term
    
    Infix
  - Utils
    
    Infix
  - Web

Legend:
Library
Module
Module type
Parameter
Class
Class type

include Protocol_9p.Client.S

type t

An established connection to a 9P server

val after_disconnect : t -> unit Lwt.t

A thread which wakes up when the connection to the server has been broken

val disconnect : t -> unit Lwt.t

Disconnect from the 9P server, but leave the underlying FLOW connected.

val create : 
  t ->
  string list ->
  string ->
  Protocol_9p__.Protocol_9p_types.FileMode.t ->
  (unit, [ `Msg of string ]) result Lwt.t

create t path name perm creates a new empty file name inside path with * the given permissions.

val write : 
  t ->
  string list ->
  int64 ->
  Cstruct.t ->
  (unit, [ `Msg of string ]) result Lwt.t

write t path offset buf writes buf to the file at path at offset offset

val read : 
  t ->
  string list ->
  int64 ->
  int32 ->
  (Cstruct.t list, [ `Msg of string ]) result Lwt.t

read t path offset count returns a list of buffers containing count bytes from offset offset in the file given by path

val mkdir : 
  t ->
  string list ->
  string ->
  Protocol_9p__.Protocol_9p_types.FileMode.t ->
  (unit, [ `Msg of string ]) result Lwt.t

mkdir t path name perm creates a new directory name inside path with * the given permissions.

val remove : t -> string list -> (unit, [ `Msg of string ]) result Lwt.t

remove t path removes a file or directory from the filesystem.

val readdir : 
  t ->
  string list ->
  (Protocol_9p__.Protocol_9p_types.Stat.t list, [ `Msg of string ]) result
    Lwt.t

Return the contents of a named directory.

val stat : 
  t ->
  string list ->
  (Protocol_9p__.Protocol_9p_types.Stat.t, [ `Msg of string ]) result Lwt.t

Return information about a named directory or named file.

module LowLevel : sig ... end

The functions in this module are mapped directly onto individual 9P RPCs. The client must carefully respect the rules on managing fids and stay within the message size limits.

val walk_from_root : 
  t ->
  Protocol_9p__.Protocol_9p_types.Fid.t ->
  string list ->
  (Protocol_9p__.Protocol_9p_response.Walk.t, [ `Msg of string ]) result Lwt.t

walk_from_root t is LowLevel.walk t root, where root is the internal Fid representing the root directory (which is not exposed by the API).

val with_fid : 
  t ->
  (Protocol_9p__.Protocol_9p_types.Fid.t ->
    ('a, [ `Msg of string ]) result Lwt.t) ->
  ('a, [ `Msg of string ]) result Lwt.t

with_fid t fn is the result of running fn x with a fresh Fid x, which is returned to the free pool when the thread finishes.

val connect : 
  string ->
  string ->
  ?msize:int32 ->
  ?username:string ->
  ?aname:string ->
  ?max_fids:int32 ->
  ?send_pings:bool ->
  unit ->
  t Protocol_9p.Error.t Lwt.t