package base

You can search for identifiers within the package.

in-package search v0.2.0

Full standard library replacement for OCaml

Install

Dune Dependency

github.com Changelog MIT License Edit opam file Versions (19)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

base-v0.14.0.tar.gz

sha256=e89c4b898d9e93527f1c84f6784f9a92a1dfa86877f39ac4450a6cb69e866de6

md5=5a00382c724e97b6768aaa27481dd3cc

doc/base/Base/Blit/index.html

Module `Base.Blit`

type nonrec ('src, 'dst) blit =
  src:'src ->
  src_pos:int ->
  dst:'dst ->
  dst_pos:int ->
  len:int ->
  unit

type nonrec ('src, 'dst) blito =
  src:'src ->
  ?src_pos:int ->
  ?src_len:int ->
  dst:'dst ->
  ?dst_pos:int ->
  unit ->
  unit

type nonrec ('src, 'dst) sub = 'src -> pos:int -> len:int -> 'dst

type nonrec ('src, 'dst) subo = ?pos:int -> ?len:int -> 'src -> 'dst

module type S = sig ... end

module type S1 = sig ... end

module type S_distinct = sig ... end

module type S1_distinct = sig ... end

module type S_to_string = sig ... end

module type Sequence = sig ... end

module type Sequence1 = sig ... end

There are various Make* functors that turn an unsafe_blit function into a blit function. The functors differ in whether the sequence type is monomorphic or polymorphic, and whether the src and dst types are distinct or are the same.

The blit functions make sure the slices are valid and then call unsafe_blit. They guarantee at a call unsafe_blit ~src ~src_pos ~dst ~dst_pos ~len that:

  len > 0
  && src_pos >= 0
  && src_pos + len <= get_src_len src
  && dst_pos >= 0
  && dst_pos + len <= get_dst_len dst

The Make* functors also automatically create unit tests.

module Make (Sequence : sig ... end) : S with type t := Sequence.t

Make is for blitting between two values of the same monomorphic type.

module Make_distinct
  (Src : Sequence)
  (Dst : sig ... end) : 
  S_distinct with type src := Src.t with type dst := Dst.t

Make_distinct is for blitting between values of distinct monomorphic types.

module Make_to_string
  (T : sig ... end)
  (To_bytes : S_distinct with type src := T.t with type dst := bytes) : 
  S_to_string with type t := T.t

module Make1 (Sequence : Sequence1) : S1 with type 'a t := 'a Sequence.t

Make1 is for blitting between two values of the same polymorphic type.

module Make1_generic
  (Sequence : Sequence1) : 
  S1 with type 'a t := 'a Sequence.t

Make1_generic is for blitting between two values of the same container type that's not fully polymorphic (in the sense of Container.Generic).