std::match_results< _Bi_iter, _Alloc >(3)

NAME
std::match_results< _Bi_iter, _Alloc > - The results of a match or search operation.

SYNOPSIS

  Public Types

28.10 Public Types
typedef sub_match< _Bi_iter > value_type
typedef const value_type & const_reference
typedef value_type & reference
typedef _Base_type::const_iterator const_iterator
typedef const_iterator iterator
typedef __iter_traits::difference_type difference_type
typedef allocator_traits< _Alloc >::size_type size_type
typedef _Alloc allocator_type
typedef __iter_traits::value_type char_type
typedef std::basic_string< char_type > string_type

  Public Member Functions

28.10.1 Construction, Copying, and Destruction
match_results ()
Constructs a default match_results container.
match_results (const _Alloc &__a) noexcept
Constructs a default match_results container.
match_results (const match_results &)=default
Copy constructs a match_results.
match_results (match_results &&) noexcept=default
Move constructs a match_results.
match_results & operator= (const match_results &)=default
Assigns rhs to *this.
match_results & operator= (match_results &&)=default
Move-assigns rhs to *this.
~match_results ()=default
Destroys a match_results object.
bool ready () const noexcept
Indicates if the match_results is ready.

28.10.2 Size
size_type size () const noexcept
Gets the number of matches and submatches.
size_type max_size () const noexcept
Gets the number of matches and submatches.
bool empty () const noexcept
Indicates if the match_results contains no results.

28.10.4 Element Access
difference_type length (size_type __sub=0) const
Gets the length of the indicated submatch.
difference_type position (size_type __sub=0) const
Gets the offset of the beginning of the indicated submatch.
string_type str (size_type __sub=0) const
Gets the match or submatch converted to a string type.
const_reference operator[] (size_type __sub) const
Gets a sub_match reference for the match or submatch.
const_reference prefix () const
Gets a sub_match representing the match prefix.
const_reference suffix () const
Gets a sub_match representing the match suffix.
const_iterator begin () const noexcept
Gets an iterator to the start of the sub_match collection.
const_iterator cbegin () const noexcept
Gets an iterator to the start of the sub_match collection.
const_iterator end () const noexcept
Gets an iterator to one-past-the-end of the collection.
const_iterator cend () const noexcept
Gets an iterator to one-past-the-end of the collection.

28.10.5 Formatting
These functions perform formatted substitution of the matched character sequences into their target. The format specifiers and escape sequences accepted by these functions are determined by their flags parameter as documented above.

template<typename _Out_iter > _Out_iter format (_Out_iter __out, const char_type *__fmt_first, const char_type *__fmt_last, match_flag_type __flags=regex_constants::format_default) const
template<typename _Out_iter , typename _St , typename _Sa > _Out_iter format (_Out_iter __out, const basic_string< char_type, _St, _Sa > &__fmt, match_flag_type __flags=regex_constants::format_default) const
template<typename _St , typename _Sa > basic_string< char_type, _St, _Sa > format (const basic_string< char_type, _St, _Sa > &__fmt, match_flag_type __flags=regex_constants::format_default) const
string_type format (const char_type *__fmt, match_flag_type __flags=regex_constants::format_default) const

28.10.6 Allocator
allocator_type get_allocator () const noexcept
Gets a copy of the allocator.

  28.10.7 Swap
template<typename , typename , typename > class regex_iterator
Swaps the contents of two match_results.
void swap (match_results &__that) noexcept
Swaps the contents of two match_results.

Detailed Description

  template<typename _Bi_iter, typename _Alloc = allocator<sub_match<_Bi_iter> >>
class std::match_results< _Bi_iter, _Alloc >" The results of a match or search operation. A collection of character sequences representing the result of a regular expression match. Storage for the collection is allocated and freed as necessary by the member functions of class template match_results.

This class satisfies the Sequence requirements, with the exception that only the operations defined for a const-qualified Sequence are supported.

The sub_match object stored at index 0 represents sub-expression 0, i.e. the whole match. In this case the sub_match member matched is always true. The sub_match object stored at index n denotes what matched the marked sub-expression n within the matched expression. If the sub-expression n participated in a regular expression match then the sub_match member matched evaluates to true, and members first and second denote the range of characters [first, second) which formed that match. Otherwise matched is false, and members first and second point to the end of the sequence that was searched.

Definition at line 39 of file regex.h.

Author

Generated automatically by Doxygen for libstdc++ from the source code.