Synchronous forward search.
It is recommended to use the asynchronous functions instead, to not block the user interface. However, if you are sure that the
buffer
is small, this function is more convenient to use.
The difference with forward is that the has_wrapped_around
out parameter has been added for convenience.
If the wrap_around property is false
, this function
doesn't try to wrap around.
The has_wrapped_around
out parameter is set independently of whether a match is found. So if this function returns
false
, has_wrapped_around
will have the same value as the
wrap_around property.
this | |
iter |
start of search. |
match_start |
return location for start of match, or |
match_end |
return location for end of match, or |
has_wrapped_around |
return location to know whether the search has wrapped around, or |
whether a match was found. |