# Regex 元字符

## 功能

说明 ^、$、.、| 等正则元字符的常见用法。

## 语法

```bt
regex(pattern, flags)
```

## 参数

| 参数 | 类型 | 必填 | 默认值 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| pattern | String | 否 | '' | 包含元字符的正则主体。 |
| flags | String | 否 | '' | 正则标志。 |

## 返回值

| 类型 | 说明 |
| ------ | ------ |
| Regex | 返回 Regex 对象。 |

## 示例

```bt
rule = regex('^(BT|Rust)$', '')
result = rule.test('Rust')

// 输出：true
print result
```

## 注意事项

- 需要匹配元字符本身时，应在 pattern 中按字符串规则写入转义字符。