package shuttle

You can search for identifiers within the package.

in-package search v0.2.0

package shuttle

shuttle
- CHANGES
- README
- Library shuttle
  - Shuttle
    
    Input_channel
    
    Output_channel
    
    Logger
    
    Flush_result
    
    Tcp_channel
    
    Bytebuffer
    
    Slice
- Sources
  - shuttle
    
    bytebuffer.ml
    
    input_channel.ml
    
    input_channel0.ml
    
    output_channel.ml
    
    output_channel0.ml
    
    shuttle.ml
    
    shuttle__.ml
    
    tcp_channel.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Shuttle.Input_channel`Source

Sourcetype t

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

Sourcetype slice = private {

buf : Core.Bigstring.t;
pos : int;
len : int;

}

Source

val create : 
  ?buf_len:int ->
  ?time_source:[> Core.read ] Async_kernel.Time_source.T1.t ->
  Async_unix.Fd.t ->
  t

Sourceval time_source : t -> Async_kernel.Time_source.t

Sourceval buffer_size : t -> int

Sourceval is_closed : t -> bool

Sourceval closed : t -> unit Async_kernel.Deferred.t

Sourceval close : t -> unit Async_kernel.Deferred.t

Sourceval refill : t -> [> `Ok | `Eof ] Async_kernel.Deferred.t

Sourceexception Timeout

Source

val refill_with_timeout : 
  t ->
  Core.Time_ns.Span.t ->
  [> `Ok | `Eof ] Async_kernel.Deferred.t

Sourceval view : t -> slice

Sourceval consume : t -> int -> unit

Sourceval drain : t -> unit Async_kernel.Deferred.t

drain t reads chunks of data from the reader and discards them.

Sourceval pipe : t -> string Async_kernel.Pipe.Reader.t

pipe returns a reader pipe that contains the results of reading chunks from an input_channel.

Source

val transfer : 
  t ->
  string Async_kernel.Pipe.Writer.t ->
  unit Async_kernel.Deferred.t

transfer will read chunks from an input channel and write them to the provided writer end of an async pipe. The deferred returned by the function will be determined on EOF or if the writer is closed. Use transfer in scenarios where pipe is needed, but if there is a need to not close the channel automatically once the transfer is finished.

Source

val of_pipe : 
  ?buf_len:int ->
  Core.Info.t ->
  string Async_kernel.Pipe.Reader.t ->
  t Async_kernel.Deferred.t

package shuttle

Module Shuttle.Input_channelSource

Module `Shuttle.Input_channel`Source