Lexical::Accessor(3pm) | User Contributed Perl Documentation | Lexical::Accessor(3pm) |
Lexical::Accessor - true private attributes for Moose/Moo/Mouse
my $accessor = lexical_has identifier => ( is => 'rw', isa => Int, default => sub { 0 }, ); # or... lexical_has identifier => ( is => 'rw', isa => Int, default => sub { 0 }, accessor => \$accessor, ); # later... say $self->$accessor; # says 0 $self->$accessor( 1 ); # setter say $self->$accessor; # says 1
Lexical::Accessor generates coderefs which can be used as methods to access private attributes for objects.
The private attributes are stored inside-out, and do not add any accessors to the class' namespace, so are completely invisible to any outside code, including any subclasses. This gives your attribute complete privacy: subclasses can define a private (or even public) attribute with the same name as your private one and they will not interfere with each other.
Private attributes cannot be initialized by Moose/Moo/Mouse constructors, but you can safely initialize them inside a "BUILD" sub.
Because lexical attributes are stored inside-out, the $name is completely optional; however a name is recommended because it allows better error messages to be generated.
The lexical_has function supports the following options:
my $reader = lexical_has "foo" => (is => "ro"); my $accessor = lexical_has "foo" => (is => "rw"); my ($reader, $writer) = lexical_has "foo" => (is => "rwp");
If generating more than one method it is probably clearer to pass in scalar references to the "reader", "writer", etc methods, rather than relying on the return value of the "lexical_has" function.
my ($get_foo, $set_foo); lexical_has foo => ( reader => \$get_foo, writer => \$set_foo, );
They can also be method names as strings:
my ($set_foo); lexical_has foo => ( reader => 'get_foo', writer => \$set_foo, );
This allows you to provide a partly public API for an attribute.
The default may be either a non-reference value, or a coderef which will be called as a method to return the value.
Builders probably make less sense than defaults because they require a method in the class' namespace. The builder may be a method name, or the special value '1' which will be interpreted as meaning the attribute name prefixed by "_build_". If a coderef is provided, this is automatically installed into the class' namespace with the "_build_" prefix. (This last feature requires Sub::Name.)
String type constraints may also be accepted, but only if Type::Utils is installed. (String type constraints are reified using "dwim_type".)
If the special value '1' is provided, the type constraint object is consulted to find the coercion. (This doesn't work for coderef type constraints.)
my ($get, $post); lexical_has ua => ( isa => 'HTTP::Tiny', default => sub { 'HTTP::Tiny'->new }, handles => [ \$get => 'get', \$post => 'post', ], ); # later... my $response = $self->$get('http://example.net/');
Supports Sub::HandlesVia:
my $remove_task; lexical_has tasks => ( isa => ArrayRef, handles_via => 'Array', handles => [ task_count => 'count', add_task => 'push', next_task => [ 'get', 0 ], \$remove_task => 'unshift', ], ); # later... while ($self->task_count) { my $task = $self->next_task; my $success = $self->handle_task($task); if ($success) { $self->$remove_task; } }
Lexical::Accessor is almost three times faster than MooX::PrivateAttributes, and almost twenty time faster than MooseX::Privacy. I'd also argue that it's a more "correct" implementation of private accessors as (short of performing impressive PadWalker manipulations), the accessors generated by this module are completely invisible to subclasses, method dispatch, etc.
Compared to the usual Moose convention of using a leading underscore to indicate a private method (which is a very loose convention; it is quite common for subclasses to override such methods!), Lexical::Accessor clearly offers much better method privacy. There should be little performance hit from using lexical accessors compared to normal Moose accessors. (However they are nowhere near the speed of the XS-powered accessors that Moo sometimes uses and Mouse usually uses.)
See also: "examples/benchmark.pl" bundled with this release.
Please report any bugs to <http://rt.cpan.org/Dist/Display.html?Queue=Lexical-Accessor>.
IRC: support is available through in the #moops channel on irc.perl.org <http://www.irc.perl.org/channels.html>.
MooX::PrivateAttributes, MooX::ProtectedAttributes, MooseX::Privacy, Sub::Private, Method::Lexical, etc...
Toby Inkster <tobyink@cpan.org>.
This software is copyright (c) 2013-2014, 2017 by Toby Inkster.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
2022-08-18 | perl v5.34.0 |