模組 StdLabels.String

module String: StringLabels

字串

type t = string 

字串的型別。

val make : int -> char -> string

make n c 會建立一個長度為 n 的字串,其中每個索引都包含字元 c

val init : int -> f:(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 : src:string -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unit

Bytes.blit_string 相同,應該優先使用它。

串接

注意。 二元運算子 (^) 會串接兩個字串。

val concat : sep: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 會以字典順序排序 s0s1compare 的行為類似於字串上的 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 -> pos:int -> len:int -> string

sub s ~pos ~len 是一個長度為 len 的字串,其中包含 s 的子字串,該子字串從位置 pos 開始,長度為 len

val split_on_char : sep: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 : f:(char -> char) -> string -> string

map f s 是將 f 應用於 s 的所有字元(以遞增順序)所產生的字串。

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

mapi ~f sStringLabels.map 類似,但字元的索引也會傳遞給 f

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

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

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

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

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

for_all p s 檢查 s 中的所有字元是否滿足謂詞 p

val exists : f:(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 : f:(char -> unit) -> string -> unit

iter ~f s 依次將函數 f 應用於 s 的所有字元。它等同於 f s.[0]; f s.[1]; ...; f s.[length s - 1]; ()

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

iteriStringLabels.iter 類似,但函數也會獲得對應的字元索引。

搜尋

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

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

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

index_from_opt s i ccs 中位置 i 之後第一次出現的索引(如果有的話)。

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

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

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

rindex_from_opt s i ccs 中位置 i+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 sStringLabels.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)編碼(反之,大端(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 會傳回 b 從字元索引 i 開始的無號 8 位元整數。

val get_int8 : string -> int -> int

get_int8 b i 會傳回 b 從字元索引 i 開始的帶號 8 位元整數。

val get_uint16_ne : string -> int -> int

get_uint16_ne b i 會傳回 b 從字元索引 i 開始的原生端無號 16 位元整數。

val get_uint16_be : string -> int -> int

get_uint16_be b i 會傳回 b 從字元索引 i 開始的大端無號 16 位元整數。

val get_uint16_le : string -> int -> int

get_uint16_le b i 會傳回 b 從字元索引 i 開始的小端無號 16 位元整數。

val get_int16_ne : string -> int -> int

get_int16_ne b i 會傳回 b 從字元索引 i 開始的原生端帶號 16 位元整數。

val get_int16_be : string -> int -> int

get_int16_be b i 會傳回 b 從字元索引 i 開始的大端帶號 16 位元整數。

val get_int16_le : string -> int -> int

get_int16_le b i 會傳回 b 從字元索引 i 開始的小端帶號 16 位元整數。

val get_int32_ne : string -> int -> int32

get_int32_ne b i 會傳回 b 從字元索引 i 開始的原生端 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 會傳回 b 從字元索引 i 開始的大端 32 位元整數。

val get_int32_le : string -> int -> int32

get_int32_le b i 會傳回 b 從字元索引 i 開始的小端 32 位元整數。

val get_int64_ne : string -> int -> int64

get_int64_ne b i 會傳回 b 從字元索引 i 開始的原生端 64 位元整數。

val get_int64_be : string -> int -> int64

get_int64_be b i 會傳回 b 從字元索引 i 開始的大端 64 位元整數。

val get_int64_le : string -> int -> int64

get_int64_le b i 會傳回 b 從字元索引 i 開始的小端 64 位元整數。