.\" Automatically generated by Pod::Man 4.10 (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 "MooseX::XSAccessor 3pm" .TH MooseX::XSAccessor 3pm "2019-02-22" "perl v5.28.1" "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" MooseX::XSAccessor \- use Class::XSAccessor to speed up Moose accessors .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& package MyClass; \& \& use Moose; \& use MooseX::XSAccessor; \& \& has foo => (...); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module accelerates Moose\-generated accessor, reader, writer and predicate methods using Class::XSAccessor. You get a speed-up for no extra effort. It is automatically applied to every attribute in the class. .PP The use of the following features of Moose attributes prevents a reader from being accelerated: .IP "\(bu" 4 Lazy builder or lazy default. .IP "\(bu" 4 Auto-deref. (Does anybody use this anyway??) .PP The use of the following features prevents a writer from being accelerated: .IP "\(bu" 4 Type constraints (except \f(CW\*(C`Any\*(C'\fR; \f(CW\*(C`Any\*(C'\fR is effectively a no-op). .IP "\(bu" 4 Triggers .IP "\(bu" 4 Weak references .PP An \f(CW\*(C`rw\*(C'\fR accessor is effectively a reader and a writer glued together, so both of the above lists apply. .PP Predicates can always be accelerated, provided you're using Class::XSAccessor 1.17 or above. .PP Clearers can not be accelerated (as of current versions of Class::XSAccessor). .SS "Functions" .IX Subsection "Functions" This module also provides one function, which is not exported so needs to be called by its full name. .ie n .IP """MooseX::XSAccessor::is_xs($sub)""" 4 .el .IP "\f(CWMooseX::XSAccessor::is_xs($sub)\fR" 4 .IX Item "MooseX::XSAccessor::is_xs($sub)" Returns a boolean indicating whether a sub is an \s-1XSUB.\s0 .Sp \&\f(CW$sub\fR may be a coderef, Class::MOP::Method object, or a qualified sub name as a string (e.g. \f(CW"MyClass::foo"\fR). .Sp This function doesn't just work with accessors, but should be able to detect the difference between Perl and \s-1XS\s0 subs in general. (It may not be 100% reliable though.) .SS "Chained accessors and writers" .IX Subsection "Chained accessors and writers" MooseX::XSAccessor can detect chained accessors and writers created using MooseX::Attribute::Chained, and can accelerate those too. .PP .Vb 4 \& package Local::Class; \& use Moose; \& use MooseX::XSAccessor; \& use MooseX::Attribute::Chained; \& \& has foo => (traits => ["Chained"], is => "rw"); \& has bar => (traits => ["Chained"], is => "ro", writer => "_set_bar"); \& has baz => ( is => "rw"); # not chained \& \& my $obj = "Local::Class"\->new; \& $obj\->foo(1)\->_set_bar(2); \& print $obj\->dump; .Ve .SS "Lvalue accessors" .IX Subsection "Lvalue accessors" MooseX::XSAccessor will detect lvalue accessors created with MooseX::LvalueAttribute and, by default, skip accelerating them. .PP However, by setting \f(CW$MooseX::XSAccessor::LVALUE\fR to true (preferably using the \f(CW\*(C`local\*(C'\fR Perl keyword), you can force it to accelerate those too. This introduces a visible change in behaviour though. MooseX::LvalueAttribute accessors normally allow two patterns for setting the value: .PP .Vb 2 \& $obj\->foo = 42; # as an lvalue \& $obj\->foo(42); # as a method call .Ve .PP However, once accelerated, they may \fIonly\fR be set as an lvalue. For this reason, setting \f(CW$MooseX::XSAccessor::LVALUE\fR to true is considered an experimental feature. .SH "HINTS" .IX Header "HINTS" .IP "\(bu" 4 Make attributes read-only when possible. This means that type constraints and coercions will only apply to the constructor, not the accessors, enabling the accessors to be accelerated. .IP "\(bu" 4 If you do need a read-write attribute, consider making the main accessor read-only, and having a separate writer method. (Like MooseX::SemiAffordanceAccessor.) .IP "\(bu" 4 Make defaults eager instead of lazy when possible, allowing your readers to be accelerated. .IP "\(bu" 4 If you need to accelerate just a specific attribute, apply the attribute trait directly: .Sp .Vb 1 \& package MyClass; \& \& use Moose; \& \& has foo => ( \& traits => ["MooseX::XSAccessor::Trait::Attribute"], \& ..., \& ); .Ve .IP "\(bu" 4 If you don't want to add a dependency on MooseX::XSAccessor, but do want to use it if it's available, the following code will use it optionally: .Sp .Vb 1 \& package MyClass; \& \& use Moose; \& BEGIN { eval "use MooseX::XSAccessor" }; \& \& has foo => (...); .Ve .SH "CAVEATS" .IX Header "CAVEATS" .IP "\(bu" 4 Calling a writer method without a parameter in Moose does not raise an exception: .Sp .Vb 1 \& $person\->set_name(); # sets name attribute to "undef" .Ve .Sp However, this is a fatal error in Class::XSAccessor. .IP "\(bu" 4 MooseX::XSAccessor does not play nice with attribute traits that alter accessor behaviour, or define additional accessors for attributes. MooseX::SetOnce is an example thereof. MooseX::Attribute::Chained is handled as a special case. .IP "\(bu" 4 MooseX::XSAccessor only works on blessed hash storage; not e.g. MooseX::ArrayRef or MooseX::InsideOut. MooseX::XSAccessor is usually able to detect such situations and silently switch itself off. .SH "BUGS" .IX Header "BUGS" Please report any bugs to . .SH "SEE ALSO" .IX Header "SEE ALSO" MooseX::XSAccessor::Trait::Attribute. .PP Moose, Moo, Class::XSAccessor. .SH "AUTHOR" .IX Header "AUTHOR" Toby Inkster . .SH "COPYRIGHT AND LICENCE" .IX Header "COPYRIGHT AND LICENCE" This software is copyright (c) 2013, 2017 by Toby Inkster. .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. .SH "DISCLAIMER OF WARRANTIES" .IX Header "DISCLAIMER OF WARRANTIES" \&\s-1THIS PACKAGE IS PROVIDED \*(L"AS IS\*(R" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.\s0