---
title: "String"
---
# String
不可變的 Unicode 字元序列。
## 靜態方法
### format_time {#format_time}
```navi
String.format_time(
time: int,
format: String,
timezone: String = symbol_info.timezone
): String
```
根據提供的格式和時區，將時間戳記（自紀元以來的毫秒數）格式化為字串。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `time` | int | | 要格式化的時間戳記（自紀元以來的毫秒數）。 |
| `format` | String | | 轉換使用的格式字串。 |
| `timezone` | String | `symbol_info.timezone` | 格式化使用的時區。 |
**返回:** String
---
### from {#from}
將整數值轉換為其字串表示形式。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `value` |
int | | 要轉換的整數值。 |
| `format` |
String | | 轉換使用的格式字串。 |
**返回:**
String
用給定格式將浮點數轉換為字串。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `value` |
float | | 要轉換的浮點值。 |
| `format` |
String | | 轉換使用的格式字串。 |
**返回:**
String
使用
Format 常數將整數轉換為字串。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `value` |
int | | 要轉換的整數值。 |
| `format` |
Format | | 控制格式化的
Format 常數。 |
**返回:**
String
使用
Format 常數將浮點數轉換為字串。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `value` |
float | | 要轉換的浮點值。 |
| `format` |
Format | | 控制格式化的
Format 常數。 |
**返回:**
String
將任意類型的值轉換為其字串表示形式。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `value` |
T | | 要轉換為字串的值。 |
**返回:**
String
String | | |
| `str` | String | | 要搜尋的子字串。 |
**返回:** bool
---
### ends_with {#ends_with}
```navi
String.ends_with(self: String, str: String): bool
```
檢查字串是否以指定後綴結尾。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
| `str` | String | | 要搜尋的後綴。 |
**返回:** bool
---
### format {#format}
```navi
String.format(self: String, values: any): String
```
將字串作為模板進行格式化，用提供的值替換 `{}` 佔位符。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
| `values` | any | | 要替換到模板中的可變數量的值。 |
**返回:** String
---
### index_of {#index_of}
```navi
String.index_of(self: String, str: String): int
```
返回子字串第一次出現的從零開始的索引，如果未找到則返回 `na`。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
| `str` | String | | 要搜尋的子字串。 |
**返回:** int
---
### length {#length}
```navi
String.length(self: String): int
```
返回字串的長度。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
**返回:** int
---
### lower {#lower}
```navi
String.lower(self: String): String
```
將字串中的所有字元轉換為小寫。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
**返回:** String
---
### match {#match}
```navi
String.match(self: String, regex: String): String
```
如果字串符合正規表達式模式，則返回匹配的子字串，否則返回空字串。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
| `regex` | String | | 要匹配的正規表達式模式。 |
**返回:** String
---
### pad_end {#pad_end}
```navi
String.pad_end(self: String, len: int, fill: String = " "): String
```
用 `fill` 在字串右側填充，直到長度至少為 `len` 個字元。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
| `len` | int | | 目標最小字元長度。 |
| `fill` | String | `" "` | 填充字串，預設為 `" "`。 |
**返回:** String
---
### pad_start {#pad_start}
```navi
String.pad_start(self: String, len: int, fill: String = " "): String
```
用 `fill` 在字串左側填充，直到長度至少為 `len` 個字元。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
| `len` | int | | 目標最小字元長度。 |
| `fill` | String | `" "` | 填充字串，預設為 `" "`。 |
**返回:** String
---
### repeat {#repeat}
```navi
String.repeat(self: String, repeat: int): String
```
返回將字串重複指定次數後的新字串。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
| `repeat` | int | | 重複字串的次數。 |
**返回:** String
---
### replace {#replace}
```navi
String.replace(
self: String,
target: String,
replacement: String,
occurrence: int = 0
): String
```
將目標子字串第 N 次出現的位置替換為指定內容。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
| `target` | String | | 要被替換的子字串。 |
| `replacement` | String | | 替換內容。 |
| `occurrence` | int | `0` | 要替換的第 N 次出現（從 0 開始）。預設為 `0`。 |
**返回:** String
---
### replace_all {#replace_all}
```navi
String.replace_all(self: String, target: String, replacement: String): String
```
將目標子字串的所有出現替換為指定內容。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
| `target` | String | | 要被替換的子字串。 |
| `replacement` | String | | 替換內容。 |
**返回:** String
---
### split {#split}
```navi
String.split(self: String, separator: String): Array
```
根據分隔符將字串拆分為子字串陣列。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
| `separator` | String | | 用於拆分的分隔符字串。 |
**返回:** Array<String>
---
### starts_with {#starts_with}
```navi
String.starts_with(self: String, str: String): bool
```
檢查字串是否以指定前綴開頭。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
| `str` | String | | 要搜尋的前綴。 |
**返回:** bool
---
### substring {#substring}
```navi
String.substring(self: String, begin_pos: int, end_pos: int): String
```
返回從 `begin_pos` 到 `end_pos`（不含）的子字串。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
| `begin_pos` | int | | 起始位置（含）。 |
| `end_pos` | int | | 結束位置（不含）。 |
**返回:** String
---
### to_number {#to_number}
```navi
String.to_number(self: String): float
```
將字串轉換為浮點數。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
**返回:** float — 解析後的浮點值，如果字串無法解析則返回 `na`。
---
### trim {#trim}
```navi
String.trim(self: String): String
```
去除字串首尾的空白字元。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
**返回:** String
---
### trim_end {#trim_end}
```navi
String.trim_end(self: String): String
```
去除字串末尾的空白字元。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
**返回:** String
---
### trim_start {#trim_start}
```navi
String.trim_start(self: String): String
```
去除字串開頭的空白字元。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
**返回:** String
---
### upper {#upper}
```navi
String.upper(self: String): String
```
將字串中的所有字元轉換為大寫。
**參數**
| 名稱 | 類型 | 預設值 | 說明 |
| --- | --- | --- | --- |
| `self` | String | | |
**返回:** String