package containers

You can search for identifiers within the package.

in-package search v0.2.0

package containers

containers
- CCArray
- CCArrayLabels
- CCAtomic
- CCBool
- CCByte_buffer
- CCByte_slice
- CCCanonical_sexp
  - Make
    
    Sexp
- CCChar
  - Infix
- CCEither
- CCEqual
  - Infix
- CCEqualLabels
  - Infix
- CCFloat
  - Infix
- CCFormat
  - ANSI_codes
  - Dump
  - Infix
- CCFun
  - Infix
  - Monad
    
    X
- CCHash
- CCHashtbl
  - Make
  - Poly
  - S
- CCHeap
  - Make
    
    E
  - Make_from_compare
    
    E
  - PARTIAL_ORD
  - S
  - TOTAL_ORD
- CCIO
  - File
- CCInt
  - Infix
- CCInt32
  - Infix
- CCInt64
  - Infix
- CCList
  - Assoc
  - Infix
  - MONAD
  - Ref
  - Traverse
    
    M
- CCListLabels
  - Assoc
  - Infix
  - MONAD
  - Ref
  - Traverse
    
    M
- CCMap
  - Make
  - S
- CCNativeint
  - Infix
- CCOpt
  - Infix
- CCOption
  - Infix
- CCOrd
  - Infix
- CCPair
- CCParse
  - Debug_
  - Error
  - Infix
  - Position
  - Slice
  - U
- CCRandom
- CCRef
- CCResult
  - Infix
  - MONAD
  - Traverse
    
    M
- CCSeq
  - Infix
  - MONAD
  - Traverse
    
    M
- CCSet
  - Make
  - S
- CCSexp
  - Decoder
  - Make
    
    Decoder
    
    Sexp
- CCSexp_intf
  - BASIC_SEXP
  - S
    
    Decoder
  - S0
  - SEXP
- CCSexp_lex
- CCString
  - Find
  - Infix
  - Split
- CCStringLabels
  - Find
  - Infix
  - Split
- CCUnit
- CCUtf8_string
- CCVector
- Containers
  - Hashtbl
    
    HashedType
    
    Make
    
    MakeSeeded
    
    H
    
    S
    
    SeededHashedType
    
    SeededS
- ContainersLabels
  - Hashtbl
    
    HashedType
    
    Make
    
    MakeSeeded
    
    H
    
    S
    
    SeededHashedType
    
    SeededS
containers.bencode
- Containers_bencode
  - Decode
  - Encode
  - Str_map
containers.cbor
- Containers_cbor
containers.codegen
- Containers_codegen
  - Bitfield
  - Code
containers.monomorphic
- CCMonomorphic
containers.pp
- Containers_pp
  - Char
  - Dump
  - Ext
  - Flatten
  - Infix
  - Out
  - Pretty
  - Term_color
containers.pvec
- Containers_pvec
containers.scc
- Containers_scc
  - ARG
  - Make
    
    A
  - S
    
    A
containers.top
- Containers_top
containers.unix
- CCUnix
  - Infix

Legend:
Library
Module
Module type
Parameter
Class
Class type

A simple byte slice.

since 3.13.1

type t = {

bs : bytes;
(*
The bytes, potentially shared between many slices
*)
mutable off : int;
(*
Offset in bs
*)
mutable len : int;
(*
Length of the slice. Valid indices are bs[off]…bs[off+len-1], inclusive.
*)

}

val show : t -> string

Simple printer (summary, doesn't show the content)

val pp : Stdlib.Format.formatter -> t -> unit

Simple printer (summary, doesn't show the content)

val create : ?off:int -> ?len:int -> bytes -> t

create bs creates a slice of bs.

parameter off
optional starting offset

parameter len
length of the slice

val unsafe_of_string : ?off:int -> ?len:int -> string -> t

unsafe_of_string s makes a slice from a string. This is unsafe because mutating the bytes is forbidden (just like with Bytes.unsafe_of_string

val len : t -> int

Access the length

val get : t -> int -> char

get sl i gets the i-th byte of the slice. Same as sl.bs.[sl.off + i].

raises Invalid_argument
if out of bounds.

val set : t -> int -> char -> unit

set sl i c sets the i-th byte to c.

raises Invalid_argument
if out of bounds.

val consume : t -> int -> unit

consume sl n moves the offset forward by n bytes, and reduces len by n bytes.

val contents : t -> string

A copy of the contents of the slice. Allocates.

val sub : t -> int -> int -> t

sub sl off len makes a new slice with the same backing bs.