模块 Stdlib.String

module String: String

字符串

type t = string 

字符串类型。

val make : int -> char -> string

make n c 是一个长度为 n 的字符串,每个索引都包含字符 c

val init : int -> (int -> char) -> string

init n f 是一个长度为 n 的字符串,索引 i 包含字符 f i(按递增的索引顺序调用)。

val empty : string

空字符串。

val length : string -> int

length ss 的长度(字节/字符数)。

val get : string -> int -> char

get s is 中索引 i 处的字符。这与编写 s.[i] 相同。

val of_bytes : bytes -> string

返回一个包含与给定字节序列相同字节的新字符串。

val to_bytes : string -> bytes

返回一个包含与给定字符串相同字节的新字节序列。

val blit : string -> int -> bytes -> int -> int -> unit

Bytes.blit_string 相同,建议优先使用。

连接

注意。 (^) 二元运算符连接两个字符串。

val concat : string -> string list -> string

concat sep ss 连接字符串列表 ss,在每个字符串之间插入分隔符字符串 sep

val cat : string -> string -> string

cat s1 s2 连接 s1 和 s2 (s1 ^ s2)。

谓词和比较

val equal : t -> t -> bool

equal s0 s1 当且仅当 s0s1 在字符级别相等时为 true

val compare : t -> t -> int

compare s0 s1 以字典顺序对 s0s1 进行排序。 compare 的行为类似于字符串上的 compare,但可能效率更高。

val starts_with : prefix:string -> string -> bool

starts_with ~prefix s 当且仅当 sprefix 开头时为 true

val ends_with : suffix:string -> string -> bool

ends_with ~suffix s 当且仅当 ssuffix 结尾时为 true

val contains_from : string -> int -> char -> bool

contains_from s start c 当且仅当 c 出现在 s 中位置 start 之后时为 true

val rcontains_from : string -> int -> char -> bool

rcontains_from s stop c 当且仅当 c 出现在 s 中位置 stop+1 之前时为 true

val contains : string -> char -> bool

contains s cString.contains_from s 0 c

提取子字符串

val sub : string -> int -> int -> string

sub s pos len 是一个长度为 len 的字符串,包含 s 的子字符串,该子字符串从位置 pos 开始,长度为 len

val split_on_char : char -> string -> string list

split_on_char sep ss 的所有(可能为空)子字符串的列表,这些子字符串由字符 sep 分隔。如果 s 为空,则结果为单元素列表 [""]

函数的结果由以下不变量指定

  • 列表不为空。
  • 使用 sep 作为分隔符连接其元素将返回一个等于输入的字符串 (concat (make 1 sep)
          (split_on_char sep s) = s
    )。
  • 结果中的任何字符串都不包含 sep 字符。

转换

val map : (char -> char) -> string -> string

map f s 是将 f 应用于 s 中所有字符的结果字符串(按升序)。

val mapi : (int -> char -> char) -> string -> string

mapi f s 类似于 String.map,但字符的索引也会传递给 f

val fold_left : ('acc -> char -> 'acc) -> 'acc -> string -> 'acc

fold_left f x s 计算 f (... (f (f x s.[0]) s.[1]) ...) s.[n-1],其中 n 是字符串 s 的长度。

val fold_right : (char -> 'acc -> 'acc) -> string -> 'acc -> 'acc

fold_right f s x 计算 f s.[0] (f s.[1] ( ... (f s.[n-1] x) ...)),其中 n 是字符串 s 的长度。

val for_all : (char -> bool) -> string -> bool

for_all p s 检查 s 中的所有字符是否满足谓词 p

val exists : (char -> bool) -> string -> bool

exists p s 检查 s 中至少一个字符是否满足谓词 p

val trim : string -> string

trim ss 去除前导和尾随空格后的结果。空格字符为:' ''\x0C'(换页符)、'\n''\r''\t'

val escaped : string -> string

escaped ss 中特殊字符用转义序列表示的结果,遵循 OCaml 的词法约定。

所有不在 US-ASCII 可打印范围 [0x20;0x7E] 内的字符都将被转义,反斜杠 (0x2F) 和双引号 (0x22) 也将被转义。

函数 Scanf.unescapedescaped 的左逆,即 Scanf.unescaped (escaped s) = s 对于任何字符串 s(除非 escaped s 失败)。

val uppercase_ascii : string -> string

uppercase_ascii ss 中所有小写字母转换为大写字母的结果,使用 US-ASCII 字符集。

val lowercase_ascii : string -> string

lowercase_ascii ss 中所有大写字母转换为小写字母的结果,使用 US-ASCII 字符集。

val capitalize_ascii : string -> string

capitalize_ascii ss 中第一个字符转换为大写字母的结果,使用 US-ASCII 字符集。

val uncapitalize_ascii : string -> string

uncapitalize_ascii ss 中第一个字符转换为小写字母的结果,使用 US-ASCII 字符集。

遍历

val iter : (char -> unit) -> string -> unit

iter f s 依次将函数 f 应用于 s 的所有字符。它等效于 f s.[0]; f s.[1]; ...; f s.[length s - 1]; ()

val iteri : (int -> char -> unit) -> string -> unit

iteri 类似于 String.iter,但函数也会获得相应的字符索引。

搜索

val index_from : string -> int -> char -> int

index_from s i cs 中位置 i 之后第一次出现 c 的索引。

val index_from_opt : string -> int -> char -> int option

index_from_opt s i cs 中位置 i 之后第一次出现 c 的索引(如果存在)。

val rindex_from : string -> int -> char -> int

rindex_from s i cs 中位置 i+1 之前最后一次出现 c 的索引。

val rindex_from_opt : string -> int -> char -> int option

rindex_from_opt s i cs 中位置 i+1 之前最后一次出现 c 的索引(如果存在)。

val index : string -> char -> int

index s cString.index_from s 0 c

val index_opt : string -> char -> int option

index_opt s cString.index_from_opt s 0 c

val rindex : string -> char -> int

rindex s cString.rindex_from s (length s - 1) c

val rindex_opt : string -> char -> int option

rindex_opt s cString.rindex_from_opt s (length s - 1) c

字符串和序列

val to_seq : t -> char Seq.t

to_seq s 是由字符串的字符按升序组成的序列。在 "unsafe-string" 模式下,迭代期间对字符串的修改将反映在序列中。

val to_seqi : t -> (int * char) Seq.t

to_seqi s 类似于 String.to_seq,但也会将相应的索引作为元组。

val of_seq : char Seq.t -> t

of_seq s 是由序列的字符组成的字符串。

UTF 解码和验证

UTF-8

val get_utf_8_uchar : t -> int -> Uchar.utf_decode

get_utf_8_uchar b i 解码 b 中索引 i 处的 UTF-8 字符。

val is_valid_utf_8 : t -> bool

is_valid_utf_8 b 当且仅当 b 包含有效的 UTF-8 数据时为 true

UTF-16BE

val get_utf_16be_uchar : t -> int -> Uchar.utf_decode

get_utf_16be_uchar b i 解码 b 中索引 i 处的 UTF-16BE 字符。

val is_valid_utf_16be : t -> bool

is_valid_utf_16be b 当且仅当 b 包含有效的 UTF-16BE 数据时为 true

UTF-16LE

val get_utf_16le_uchar : t -> int -> Uchar.utf_decode

get_utf_16le_uchar b i 解码 b 中索引 i 处的 UTF-16LE 字符。

val is_valid_utf_16le : t -> bool

is_valid_utf_16le b 当且仅当 b 包含有效的 UTF-16LE 数据时为 true

整数的二进制解码

本节中的函数从字符串中二进制解码整数。

以下所有函数在解码整数所需的索引 i 处的字符不可用时都引发 Invalid_argument

小端(resp. 大端)编码意味着最低(resp. 最高)有效字节存储在最前面。大端也称为网络字节序。原生端编码根据Sys.big_endian,可以是小端或大端。

32 位和 64 位整数分别由 int32int64 类型表示,它们可以解释为有符号或无符号数字。

8 位和 16 位整数由 int 类型表示,它比二进制编码具有更多位。对于解码 8 位或 16 位整数并将其表示为 int 值的函数,这些额外的位会被符号扩展(或零扩展)。

val get_uint8 : string -> int -> int

get_uint8 b i 是从字符索引 i 开始的 b 的无符号 8 位整数。

val get_int8 : string -> int -> int

get_int8 b i 是从字符索引 i 开始的 b 的有符号 8 位整数。

val get_uint16_ne : string -> int -> int

get_uint16_ne b i 是从字符索引 i 开始的 b 的原生端无符号 16 位整数。

val get_uint16_be : string -> int -> int

get_uint16_be b i 是从字符索引 i 开始的 b 的大端无符号 16 位整数。

val get_uint16_le : string -> int -> int

get_uint16_le b i 是从字符索引 i 开始的 b 的小端无符号 16 位整数。

val get_int16_ne : string -> int -> int

get_int16_ne b i 是从字符索引 i 开始的 b 的原生端有符号 16 位整数。

val get_int16_be : string -> int -> int

get_int16_be b i 是从字符索引 i 开始的 b 的大端有符号 16 位整数。

val get_int16_le : string -> int -> int

get_int16_le b i 是从字符索引 i 开始的 b 的小端有符号 16 位整数。

val get_int32_ne : string -> int -> int32

get_int32_ne b i 是从字符索引 i 开始的 b 的原生端 32 位整数。

val hash : t -> int

一个用于字符串的无种子哈希函数,其输出值与 Hashtbl.hash 相同。此函数允许将此模块作为参数传递给函子 Hashtbl.Make

val seeded_hash : int -> t -> int

一个用于字符串的有种子哈希函数,其输出值与 Hashtbl.seeded_hash 相同。此函数允许将此模块作为参数传递给函子 Hashtbl.MakeSeeded

val get_int32_be : string -> int -> int32

get_int32_be b i 是从字符索引 i 开始的 b 的大端 32 位整数。

val get_int32_le : string -> int -> int32

get_int32_le b i 是从字符索引 i 开始的 b 的小端 32 位整数。

val get_int64_ne : string -> int -> int64

get_int64_ne b i 是从字符索引 i 开始的 b 的原生端 64 位整数。

val get_int64_be : string -> int -> int64

get_int64_be b i 是从字符索引 i 开始的 b 的大端 64 位整数。

val get_int64_le : string -> int -> int64

get_int64_le b i 是从字符索引 i 开始的 b 的小端 64 位整数。