Batteries user guide : BatString.Cap

# Module BatString.Cap

    module Cap: sig .. end

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 : 'a t -> int

    val is_empty : 'a t -> bool

    val get : [> `Read ] t -> int -> char

    val set : [> `Write ] t -> int -> char -> unit

    val create : int -> 'a t

###### Constructors

    val of_string : string -> 'a 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 -> 'a t

    val init : int -> (int -> char) -> 'a t

    val enum : [> `Read ] t -> char BatEnum.t

###### Conversions

    val of_enum : char BatEnum.t -> 'a t

    val backwards : [> `Read ] t -> char BatEnum.t

    val of_backwards : char BatEnum.t -> 'a t

    val of_list : char list -> 'a t

    val to_list : [> `Read ] t -> char list

    val of_int : int -> 'a t

    val of_float : float -> 'a t

    val of_char : char -> 'a t

    val to_int : [> `Read ] t -> int

    val to_float : [> `Read ] t -> float

###### String traversals

    val map : (char -> char) -> [> `Read ] t -> 'a t

    val mapi : (int -> char -> char) -> [> `Read ] t -> 'a 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 -> 'a t

    val filter_map : (char -> char option) -> [> `Read ] t -> 'a 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 -> 'a t

    val rchop : ?n:int -> [> `Read ] t -> 'a t

    val trim : [> `Read ] t -> 'a t

    val quote : [> `Read ] t -> string

    val left : [> `Read ] t -> int -> 'a t

    val right : [> `Read ] t -> int -> 'a t

    val head : [> `Read ] t -> int -> 'a t

    val tail : [> `Read ] t -> int -> 'a t

    val strip : ?chars:[> `Read ] t ->
           [> `Read ] t -> 'a t

    val uppercase : [> `Read ] t -> 'a t

    val lowercase : [> `Read ] t -> 'a t

    val capitalize : [> `Read ] t -> 'a t

    val uncapitalize : [> `Read ] t -> 'a t

    val copy : [> `Read ] t -> 'a t

    val sub : [> `Read ] t -> int -> int -> 'a 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 -> 'a t

    val escaped : [> `Read ] t -> 'a t

    val replace_chars : (char -> [> `Read ] t) ->
           [> `Read ] t -> 'a t

    val replace : str:[> `Read ] t ->
           sub:[> `Read ] t ->
           by:[> `Read ] t -> bool * 'a t

    val nreplace : str:[> `Read ] t ->
           sub:[> `Read ] t ->
           by:[> `Read ] t -> 'a t

    val repeat : [> `Read ] t -> int -> 'a t

    val split : [> `Read ] t ->
           by:[> `Read ] t -> 'a t * 'b t

###### Splitting around

    val rsplit : [> `Read ] t -> by:string -> string * string

    val nsplit : [> `Read ] t ->
           by:[> `Read ] t -> 'a t list

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

    val join : [> `Read ] t ->
           [> `Read ] t list -> 'a t

    val slice : ?first:int -> ?last:int -> [> `Read ] t -> 'a t

    val explode : [> `Read ] t -> char list

    val implode : char list -> 'a 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