std::match_results<BidirIt,Alloc>::format

 

C++

编译器支持

独立和宿主式

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

文本处理库

本地化库

正则表达式库 (C++11)

格式化库 (C++20)

空终止序列工具

字节字符串

多字节字符串

宽字符串

原始数值转换

to_chars (C++17) to_chars_result (C++17) from_chars (C++17) from_chars_result (C++17) chars_format (C++17)

文本编码识别

text_encoding (C++26)

 

正则表达式库

类

basic_regex (C++11)

sub_match (C++11)

match_results (C++11)

算法

regex_match (C++11)

regex_search (C++11)

regex_replace (C++11)

迭代器

regex_iterator (C++11)

regex_token_iterator (C++11)

异常

regex_error (C++11)

特性

regex_traits (C++11)

常量

syntax_option_type (C++11)

match_flag_type (C++11)

error_type (C++11)

正则表达式语法

修改后的 ECMAScript-262 (C++11)

 

std::match_results

成员函数

match_results::match_results

match_results::~match_results

match_results::operator=

match_results::get_allocator

状态

match_results::ready

元素访问

match_results::size

match_results::max_size

match_results::empty

match_results::length

match_results::position

match_results::str

match_results::operator[]

match_results::prefix

match_results::suffix

迭代器

match_results::beginmatch_results::cbegin

match_results::endmatch_results::cend

格式化

match_results::format

修饰符

match_results::swap

非成员函数

operator==operator!= (until C++20)

swap(std::match_results)

 

template< class OutputIt > OutputIt format( OutputIt out,                  const char_type* fmt_first, const char_type* fmt_last,                  std::regex_constants::match_flag_type flags =                      std::regex_constants::format_default ) const;	(1)	(since C++11)
template< class OutputIt, class ST, class SA > OutputIt format( OutputIt out,                  const basic_string<char_type,ST,SA>& fmt,                  std::regex_constants::match_flag_type flags =                      std::regex_constants::format_default ) const;	(2)	(since C++11)
template< class ST, class SA > std::basic_string<char_type,ST,SA>     format( const std::basic_string<char_type,ST,SA>& fmt,             std::regex_constants::match_flag_type flags =                 std::regex_constants::format_default ) const;	(3)	(since C++11)
string_type format( const char_type* fmt_s,                     std::regex_constants::match_flag_type flags =                         std::regex_constants::format_default ) const;	(4)	(since C++11)

format 输出一个格式化字符串，将该字符串中的任何格式说明符或转义序列替换为来自 *this 的匹配数据。

1) 格式化字符序列由范围 [fmt_first, fmt_last) 定义。结果字符序列被复制到 out。

2) 格式化字符序列由 fmt 中的字符定义。结果字符序列被复制到 out。

3,4) 格式化字符序列分别由 fmt 和 fmt_s 中的字符定义。结果字符序列被复制到一个新构造的 std::basic_string，并返回。

flags 位掩码确定哪些格式说明符和转义序列被识别。

如果 ready() != true，则 format 的行为是未定义的。

参数

fmt_begin, fmt_end	-	指向定义格式化字符序列的字符范围的指针
fmt	-	std::basic_string 定义格式化字符序列
fmt_s	-	指向定义格式化字符序列的空终止字符字符串的指针
out	-	结果字符序列复制到的迭代器
flags	-	std::regex_constants::match_flag_type 位掩码，指定识别哪些格式说明符和转义序列
类型要求
- OutputIt 必须满足 LegacyOutputIterator 的要求。

返回值

1,2) out

3,4) 新构造的包含结果字符序列的字符串。

异常

可能抛出实现定义的异常。

示例

运行此代码

#include <iostream>
#include <regex>
#include <string>
 
int main()
{
    std::string s = "for a good time, call 867-5309";
    std::regex phone_regex("\\d{3}-\\d{4}");
    std::smatch phone_match;
 
    if (std::regex_search(s, phone_match, phone_regex))
    {
        std::string fmt_s = phone_match.format(
            "$`"   // $` means characters before the match
            "[$&]" // $& means the matched characters
            "$'"); // $' means characters following the match
        std::cout << fmt_s << '\n';
    }   
}

输出

for a good time, call [867-5309]

参见

regex_replace (C++11)	替换正则表达式的出现，使用格式化的替换文本 (函数模板)
match_flag_type (C++11)	匹配特定的选项 (类型定义)