Blit (core_kernel.Core

include module type of struct include Base.Blit end

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 = Base__Blit_intf.S

module type S1 = Base__Blit_intf.S1

module type S_distinct = Base__Blit_intf.S_distinct

module type S_to_string = Base__Blit_intf.S_to_string

module type Sequence = Base__Blit_intf.Sequence

module type Sequence1 = Base__Blit_intf.Sequence1

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 : functor (Sequence : sig ... end) -> S with type t := Sequence.t

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

module Make_distinct : functor (Src : Sequence) -> functor (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 : functor (T : sig ... end) -> functor (To_bytes : S_distinct with type src := T.t with type dst := bytes) -> S_to_string with type t := T.t

module Make1 : functor (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 : functor (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).

module type S_permissions = Core_kernel__Blit_intf.S_permissions

module type S1_permissions = Core_kernel__Blit_intf.S1_permissions