模組 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

當且僅當 s0s1 的字元逐一相等時,equal s0 s1true

val compare : t -> t -> int

compare s0 s1 會依詞彙順序排序 s0s1compare 的行為與字串上的 compare 相同,但可能更有效率。

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

當且僅當 sprefix 開頭時,starts_with ~prefix strue

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

當且僅當 ssuffix 結尾時,ends_with ~suffix strue

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

當且僅當 c 出現在 sstart 位置之後時,contains_from s start ctrue

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

當且僅當 c 出現在 sstop+1 位置之前時,rcontains_from s stop ctrue

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 sString.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 的左反函式,亦即,對於任何字串 sScanf.unescaped (escaped 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

iteriString.iter 類似,但也會將對應的字元索引提供給函式。

搜尋

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

index_from s i ccsi 位置之後第一次出現的索引。

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

index_from_opt s i ccsi 位置之後第一次出現的索引 (若有的話)。

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

rindex_from s i ccsi+1 位置之前最後一次出現的索引。

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

rindex_from_opt s i ccsi+1 位置之前最後一次出現的索引 (若有的話)。

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 sString.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 異常。

小端(little-endian,resp.)編碼表示最低有效位元組先儲存。大端(big-endian)編碼表示最高有效位元組先儲存。大端也稱為網路位元組順序。原生端(Native-endian)編碼根據 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 位元整數。