String::Tagged::Extent - represents a range within a String::Tagged
String::Tagged::Extent
String::Tagged
These objects represent a range of characters within the containing String::Tagged object. The range they represent is fixed at the time of creation. If the containing string is modified by a call to set_substr then the effect on the extent object is not defined. These objects should be considered as relatively short-lived - used briefly for the purpose of querying the result of an operation, then discarded soon after.
set_substr
$extent->string
Returns the containing String::Tagged object.
$extent->start
Returns the start index of the extent. This is the index of the first character within the extent.
$extent->end
Returns the end index of the extent. This is the index of the first character beyond the end of the extent.
$extent->anchor_before
True if this extent begins "before" the start of the string. Only certain methods return extents with this flag defined.
$extent->anchor_after
True if this extent ends "after" the end of the string. Only certain methods return extents with this flag defined.
$extent->length
Returns the number of characters within the extent.
$extent->substr
Returns the substring contained by the extent, as a String::Tagged complete with all the relevant tag values.
$extent->plain_substr
Returns the substring of the underlying plain string buffer contained by the extent, as a plain Perl string.
Paul Evans <leonerd@leonerd.org.uk>
To install String::Tagged, copy and paste the appropriate command in to your terminal.
cpanm
cpanm String::Tagged
CPAN shell
perl -MCPAN -e shell install String::Tagged
For more information on module installation, please visit the detailed CPAN module installation guide.