.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Data::Perl::Role::String 3pm"
.TH Data::Perl::Role::String 3pm "2020-01-24" "perl v5.30.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Data::Perl::Role::String \- Wrapping class for Perl scalar strings.
.SH "VERSION"
.IX Header "VERSION"
version 0.002011
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Data::Perl qw/string/;
\&
\&  my $string = string("foo\en");
\&
\&  $string\->chomp; # returns 1, $string == "foo"
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class provides a wrapper and methods for interacting with scalar strings.
.SH "PROVIDED METHODS"
.IX Header "PROVIDED METHODS"
.IP "\(bu" 4
\&\fBnew($value)\fR
.Sp
Constructs a new Data::Perl::String object, optionally initialized to \f(CW$value\fR if
passed in, and returns it.
.IP "\(bu" 4
\&\fBinc\fR
.Sp
Increments the value stored in this slot using the magical string autoincrement
operator. Note that Perl doesn't provide analogous behavior in \f(CW\*(C`\-\-\*(C'\fR, so
\&\f(CW\*(C`dec\*(C'\fR is not available. This method returns the new value.
.Sp
This method does not accept any arguments.
.IP "\(bu" 4
\&\fBappend($string)\fR
.Sp
Appends to the string, like \f(CW\*(C`.=\*(C'\fR, and returns the new value.
.Sp
This method requires a single argument.
.IP "\(bu" 4
\&\fBprepend($string)\fR
.Sp
Prepends to the string and returns the new value.
.Sp
This method requires a single argument.
.IP "\(bu" 4
\&\fBreplace($pattern, \f(CB$replacement\fB)\fR
.Sp
Performs a regexp substitution (\*(L"s\*(R" in perlop). There is no way to provide the
\&\f(CW\*(C`g\*(C'\fR flag, but code references will be accepted for the replacement, causing
the regex to be modified with a single \f(CW\*(C`e\*(C'\fR. \f(CW\*(C`/smxi\*(C'\fR can be applied using the
\&\f(CW\*(C`qr\*(C'\fR operator. This method returns the new value.
.Sp
This method requires two arguments.
.IP "\(bu" 4
\&\fBmatch($pattern)\fR
.Sp
Runs the regex against the string and returns the matching value(s).
.Sp
This method requires a single argument.
.IP "\(bu" 4
\&\fBchop\fR
.Sp
Just like \*(L"chop\*(R" in perlfunc. This method returns the chopped character.
.Sp
This method does not accept any arguments.
.IP "\(bu" 4
\&\fBchomp\fR
.Sp
Just like \*(L"chomp\*(R" in perlfunc. This method returns the number of characters
removed.
.Sp
This method does not accept any arguments.
.IP "\(bu" 4
\&\fBclear\fR
.Sp
Sets the string to the empty string (not the value passed to \f(CW\*(C`default\*(C'\fR).
.Sp
This method does not have a defined return value.
.Sp
This method does not accept any arguments.
.IP "\(bu" 4
\&\fBlength\fR
.Sp
Just like \*(L"length\*(R" in perlfunc, returns the length of the string.
.IP "\(bu" 4
\&\fBsubstr\fR
.Sp
This acts just like \*(L"substr\*(R" in perlfunc. When called as a writer, it returns
the substring that was replaced, just like the Perl builtin.
.Sp
This method requires at least one argument, and accepts no more than three.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
Data::Perl
.IP "\(bu" 4
MooX::HandlesVia
.SH "AUTHOR"
.IX Header "AUTHOR"
Matthew Phillips <mattp@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2020 by Matthew Phillips <mattp@cpan.org>.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.