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

 

C++

语言

标准库头文件

自立与有宿主实现

具名要求

语言支持库

概念库 (C++20)

诊断库

工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

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

原子操作库 (C++11)

线程支持库 (C++11)

技术规范

 

正则表达式库

类

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)

正则表达式文法

Modified 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!= (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)	(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)	(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)	(C++11 起)
string_type format( const char_type* fmt_s,                     std::regex_constants::match_flag_type flags =                         std::regex_constants::format_default ) const;	(4)	(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 <string>
#include <regex>
 
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(
            "$`"    // $` 意味着匹配之前的字符
            "[$&]"  // $& 意味着匹配的字符
            "$'");  // $' 意味着后随匹配的字符
        std::cout << fmt_s << '\n';
    }   
}

输出：

for a good time, call [867-5309]

参阅

regex_replace (C++11)	以格式化的替换文本来替换正则表达式匹配的出现位置 (函数模板)
match_flag_type (C++11)	特定于匹配的选项 (typedef)