Data::...String(3pm)

💖 Data::Perl::Role::String — the perl manual page, but make it cute 💖

okay bestie, so this is Data::Perl::Role::String(3pm) — a User Contributed Perl Documentation page, living in your terminal, and ngl it's kind of a little icon. It's a wrapping class for Perl scalar strings. Strings! The moment. The vibe. Let's get into it ✨

---

✨ VERSION ✨

version 0.002011 — yes ma'am, that's the number, memorize it 💅

---

🌸 SYNOPSIS 🌸

here's the whole entire vibe, copy-paste ready, no cap:

use Data::Perl qw/string/;

my $string = string("foo\n");

$string->chomp; # returns 1, $string == "foo"

see that? you make a string, you chomp it, it becomes "foo", it hands you back a 1. chef's kiss. 🎀

---

🦋 DESCRIPTION 🦋

So basically, this class is your whole wrapper-and-methods situation for interacting with scalar strings. That's it. That's the job. She wraps, she provides methods, she serves. 💖

---

👑 PROVIDED METHODS 👑

Every single one, listed, because we do not skip. Not here. Not ever.

• new($value) — Constructs a brand new Data::Perl::String object and returns it. If you pass in $value, she's initialized with it. If you don't, she's just out here existing. Your call, bestie 🫶
• inc — Increments the value stored in this slot using the magical string autoincrement operator. ⚠️ Important tea: Perl doesn't provide analogous behavior in "--", so dec is not available. Don't go looking for her, she's not coming. Returns the new value.

This method does not accept any arguments. Zero. None. 🙈

• append($string) — Appends to the string, like .=, and returns the new value.

This method requires a single argument.

• prepend($string) — Prepends to the string and returns the new value.

This method requires a single argument.

• replace($pattern, $replacement) — Performs a regexp substitution (that's "s" in perlop, iykyk). 🚨 Heads up: there is no way to provide the "g" flag. Instead, code references will be accepted for the replacement, and that causes the regex to be modified with a single "e". Also, "/smxi" can be applied using the "qr" operator. Returns the new value.

This method requires two arguments.

• match($pattern) — Runs the regex against the string and returns the matching value(s). Slay 💅

This method requires a single argument.

• chop — Just like "chop" in perlfunc. Returns the chopped character.

This method does not accept any arguments.

• chomp — Just like "chomp" in perlfunc. Returns the number of characters removed.

This method does not accept any arguments.

• clear — Sets the string to the empty string. 📢 And like — specifically the empty string, not the value passed to "default". Read that again. Not the default. The empty one.

This method does not have a defined return value.

This method does not accept any arguments.

• length — Just like "length" in perlfunc, returns the length of the string. Short king behavior, measuring things. 🌈
• substr — This acts just like "substr" in perlfunc. And when you call it as a writer, it returns the substring that was replaced, just like the Perl builtin does. Consistent! Iconic!

This method requires at least one argument, and accepts no more than three.

---

🔥 SEE ALSO 🔥

go read these too, they're the friends of the family:

• Data::Perl
• MooX::HandlesVia

---

💜 AUTHOR 💜

Matthew Phillips <mattp@cpan.org> — thank you for your service 🫡

---

🎀 COPYRIGHT AND LICENSE 🎀

This software is copyright (c) 2020 by Matthew Phillips <mattp@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

---

and that's the whole page, bestie, every last crumb of it 💖 this little doc came to you from perl v5.36.0, dated 2022-10-16, and honestly? she ate. periodt. 🌸✨👑