match overloads

Synopses

Declared in <bdlpcre_regex.h>

Match the specified subject against pattern(). Begin matching at the optionally specified subjectOffset in subject. If subjectOffset is not specified, matching begins at the start of subject. UTF‐8 validity checking is performed on subject if pattern() was prepared with k_FLAG_UTF8. Return k_STATUS_SUCCESS on success, k_STATUS_NO_MATCH if a match is not found, and another value if an error occurs. If the returned status is not k_STATUS_SUCCESS or k_STATUS_NO_MATCH it may match one of specific k_STATUS_* error return constants defined above (but is not guaranteed to). The behavior is undefined unless true == isPrepared() and subjectOffset <= subject.length(). Note that JIT optimization is disabled if pattern() was prepared with k_FLAG_UTF8; use matchRaw if JIT is preferred and UTF‐8 validation of subject is not required.

int
match(
    std::string_view const& subject,
    size_t subjectOffset = 0) const;

» more...

Match the specified subject against pattern(). Begin matching at the optionally specified subjectOffset in subject. If subjectOffset is not specified, matching begins at the start of subject. UTF‐8 validity checking is performed on subject if pattern() was prepared with k_FLAG_UTF8. Return k_STATUS_SUCCESS on success, k_STATUS_NO_MATCH if a match is not found, and another value if an error occurs. If the returned status is not k_STATUS_SUCCESS or k_STATUS_NO_MATCH it may match one of specific k_STATUS_* error return constants defined above (but is not guaranteed to). result is unchanged if a value other than k_STATUS_SUCCESS is returned. The behavior is undefined unless true == isPrepared() and subjectOffset <= subject.length(). Note that JIT optimization is disabled if pattern() was prepared with k_FLAG_UTF8; use matchRaw if JIT is preferred and UTF‐8 validation of subject is not required.

int
match(
    std::string_view* result,
    std::string_view const& subject,
    size_t subjectOffset = 0) const;

» more...

Match subject against pattern(), loading subpattern matches into result. Begin matching at the optionally specified subjectOffset. UTF‐8 validity checking is performed on subject if pattern() was prepared with k_FLAG_UTF8. Return k_STATUS_SUCCESS on success.

int
match(
    bsl::vector<std::string_view>* result,
    std::string_view const& subject,
    size_t subjectOffset = 0) const;

» more...

Same as the preceding overload, using a std::pmr::vector buffer.

int
match(
    std::pmr::vector<std::string_view>* result,
    std::string_view const& subject,
    size_t subjectOffset = 0) const;

» more...

Same as the preceding overload, using a std::vector result buffer.

int
match(
    std::vector<std::string_view>* result,
    std::string_view const& subject,
    size_t subjectOffset = 0) const;

» more...

Match the specified subject having the specified subjectLength against pattern(). Begin matching at the optionally specified subjectOffset in subject. If subjectOffset is not specified, matching begins at the start of subject. subject may contain embedded null characters. UTF‐8 validity checking is performed on subject if pattern() was prepared with k_FLAG_UTF8. Return k_STATUS_SUCCESS on success, k_STATUS_NO_MATCH if a match is not found, and another value if an error occurs. If the returned status is not k_STATUS_SUCCESS or k_STATUS_NO_MATCH it may match one of specific k_STATUS_* error return constants defined above (but is not guaranteed to). The behavior is undefined unless true == isPrepared(), subject || 0 == subjectLength, and subjectOffset <= subjectLength. Note that JIT optimization is disabled if pattern() was prepared with k_FLAG_UTF8; use matchRaw if JIT is preferred and UTF‐8 validation of subject is not required.

int
match(
    char const* subject,
    size_t subjectLength,
    size_t subjectOffset = 0) const;

» more...

Same as the preceding overload, loading a string_view match result.

int
match(
    std::string_view* result,
    char const* subject,
    size_t subjectLength,
    size_t subjectOffset = 0) const;

» more...

Match the specified subject having the specified subjectLength against pattern(). Begin matching at the optionally specified subjectOffset in subject. If subjectOffset is not specified, matching begins at the start of subject. subject may contain embedded null characters. UTF‐8 validity checking is performed on subject if pattern() was prepared with k_FLAG_UTF8. Return k_STATUS_SUCCESS on success, k_STATUS_NO_MATCH if a match is not found, and another value if an error occurs. If the returned status is not k_STATUS_SUCCESS or k_STATUS_NO_MATCH it may match one of specific k_STATUS_* error return constants defined above (but is not guaranteed to). result is unchanged if a value other than k_STATUS_SUCCESS is returned. The behavior is undefined unless true == isPrepared(), subject || 0 == subjectLength, and subjectOffset <= subjectLength. Note that JIT optimization is disabled if pattern() was prepared with k_FLAG_UTF8; use matchRaw if JIT is preferred and UTF‐8 validation of subject is not required.

int
match(
    bsl::pair<size_t, size_t>* result,
    char const* subject,
    size_t subjectLength,
    size_t subjectOffset = 0) const;

» more...

Same as the preceding overload, loading StringRef match results.

int
match(
    bsl::vector<bslstl::StringRef>* result,
    char const* subject,
    size_t subjectLength,
    size_t subjectOffset = 0) const;

» more...

Match the specified subject having the specified subjectLength against pattern(). Begin matching at the optionally specified subjectOffset in subject. If subjectOffset is not specified, matching begins at the start of subject. subject may contain embedded null characters. UTF‐8 validity checking is performed on subject if pattern() was prepared with k_FLAG_UTF8. On success:

int
match(
    bsl::vector<bsl::pair<size_t, size_t>>* result,
    char const* subject,
    size_t subjectLength,
    size_t subjectOffset = 0) const;

» more...

Created with MrDocs