package containers

  1. Overview
  2. Docs

Module CCByte_sliceSource

A simple byte slice.

  • since 3.13.1
Sourcetype t = {
  1. bs : bytes;
    (*

    The bytes, potentially shared between many slices

    *)
  2. mutable off : int;
    (*

    Offset in bs

    *)
  3. mutable len : int;
    (*

    Length of the slice. Valid indices are bs[off]…bs[off+len-1], inclusive.

    *)
}
Sourceval show : t -> string

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

Sourceval pp : Format.formatter -> t -> unit

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

Sourceval 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

Sourceval 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

Sourceval len : t -> int

Access the length

Sourceval get : t -> int -> char

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

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

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

Sourceval consume : t -> int -> unit

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

Sourceval contents : t -> string

A copy of the contents of the slice. Allocates.

Sourceval sub : t -> int -> int -> t

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