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

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (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!= (直到 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	-	指向定義格式字元序列的以 null 結尾的字串的指標
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)	匹配特有的選項 (typedef)