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