package batteries

  1. Overview
  2. Docs
package batteries
Legend:
Library
Module
Module type
Parameter
Class
Class type

Capabilities for strings.

This modules provides the same set of features as String, but with the added twist that strings can be made read-only or write-only. Read-only strings may then be safely shared and distributed.

There is no loss of performance involved.

type 'a t

The type of capability strings.

If 'a contains [`Read], the contents of the string may be read. If 'a contains [`Write], the contents of the string may be written.

Other (user-defined) capabilities may be added without loss of performance or features. For instance, a string could be labelled [`Read | `UTF8] to state that it contains UTF-8 encoded data and may be used only for reading. Conversely, a string labelled with [] (i.e. nothing) can neither be read nor written. It can only be compared for textual equality using OCaml's built-in compare or for physical equality using OCaml's built-in ==.

val length : _ t -> int
val is_empty : _ t -> bool
val get : [> `Read ] t -> int -> char
val set : [> `Write ] t -> int -> char -> unit
val create : int -> _ t
Constructors
val of_string : string -> _ t

Adopt a regular string.

val to_string : [ `Read | `Write ] t -> string

Return a capability string as a regular string.

val read_only : [> `Read ] t -> [ `Read ] t

Drop capabilities to read only.

val write_only : [> `Write ] t -> [ `Write ] t

Drop capabilities to write only.

val make : int -> char -> _ t
val init : int -> (int -> char) -> _ t
val enum : [> `Read ] t -> char BatEnum.t

Conversions

val of_enum : char BatEnum.t -> _ t
val backwards : [> `Read ] t -> char BatEnum.t
val of_backwards : char BatEnum.t -> _ t
val of_list : char list -> _ t
val to_list : [> `Read ] t -> char list
val of_int : int -> _ t
val of_float : float -> _ t
val of_char : char -> _ t
val to_int : [> `Read ] t -> int
val to_float : [> `Read ] t -> float
String traversals
val map : (char -> char) -> [> `Read ] t -> _ t
val mapi : (int -> char -> char) -> [> `Read ] t -> _ t
val fold_left : ('a -> char -> 'a) -> 'a -> [> `Read ] t -> 'a
val fold_lefti : ('a -> int -> char -> 'a) -> 'a -> [> `Read ] t -> 'a
val fold_right : (char -> 'a -> 'a) -> [> `Read ] t -> 'a -> 'a
val fold_righti : (int -> char -> 'a -> 'a) -> [> `Read ] t -> 'a -> 'a
val filter : (char -> bool) -> [> `Read ] t -> _ t
val filter_map : (char -> char option) -> [> `Read ] t -> _ t
val iter : (char -> unit) -> [> `Read ] t -> unit
Finding
val index : [> `Read ] t -> char -> int
val rindex : [> `Read ] t -> char -> int
val index_from : [> `Read ] t -> int -> char -> int
val rindex_from : [> `Read ] t -> int -> char -> int
val contains : [> `Read ] t -> char -> bool
val contains_from : [> `Read ] t -> int -> char -> bool
val rcontains_from : [> `Read ] t -> int -> char -> bool
val find : [> `Read ] t -> [> `Read ] t -> int
val find_from : [> `Read ] t -> int -> [> `Read ] t -> int
val rfind : [> `Read ] t -> [> `Read ] t -> int
val rfind_from : [> `Read ] t -> int -> [> `Read ] t -> int
val ends_with : [> `Read ] t -> [> `Read ] t -> bool
val starts_with : [> `Read ] t -> [> `Read ] t -> bool
val exists : [> `Read ] t -> [> `Read ] t -> bool
Transformations
val lchop : ?n:int -> [> `Read ] t -> _ t
val rchop : ?n:int -> [> `Read ] t -> _ t
val chop : ?l:int -> ?r:int -> [> `Read ] t -> string
val trim : [> `Read ] t -> _ t
val quote : [> `Read ] t -> string
val left : [> `Read ] t -> int -> _ t
val right : [> `Read ] t -> int -> _ t
val head : [> `Read ] t -> int -> _ t
val tail : [> `Read ] t -> int -> _ t
val strip : ?chars:[> `Read ] t -> [> `Read ] t -> _ t
val uppercase : [> `Read ] t -> _ t
val lowercase : [> `Read ] t -> _ t
val capitalize : [> `Read ] t -> _ t
val uncapitalize : [> `Read ] t -> _ t
val copy : [> `Read ] t -> _ t
val sub : [> `Read ] t -> int -> int -> _ t
val fill : [> `Write ] t -> int -> int -> char -> unit
val blit : [> `Read ] t -> int -> [> `Write ] t -> int -> int -> unit
val concat : [> `Read ] t -> [> `Read ] t list -> _ t
val escaped : [> `Read ] t -> _ t
val replace_chars : (char -> [> `Read ] t) -> [> `Read ] t -> _ t
val replace : str:[> `Read ] t -> sub:[> `Read ] t -> by:[> `Read ] t -> bool * _ t
val nreplace : str:[> `Read ] t -> sub:[> `Read ] t -> by:[> `Read ] t -> _ t
val repeat : [> `Read ] t -> int -> _ t
val split : [> `Read ] t -> by:[> `Read ] t -> _ t * _ t

Splitting around

val rsplit : [> `Read ] t -> by:string -> string * string
val nsplit : [> `Read ] t -> by:[> `Read ] t -> _ t list
val splice : [ `Read | `Write ] t -> int -> int -> [> `Read ] t -> string
val join : [> `Read ] t -> [> `Read ] t list -> _ t
val slice : ?first:int -> ?last:int -> [> `Read ] t -> _ t
val explode : [> `Read ] t -> char list
val implode : char list -> _ t
Comparisons
val compare : [> `Read ] t -> [> `Read ] t -> int
val icompare : [> `Read ] t -> [> `Read ] t -> int
Printing
val print : 'a BatInnerIO.output -> [> `Read ] t -> unit
val println : 'a BatInnerIO.output -> [> `Read ] t -> unit
val print_quoted : 'a BatInnerIO.output -> [> `Read ] t -> unit
module Exceptionless : sig ... end

Exceptionless counterparts for error-raising operations

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct