logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Sub::HandlesVia::Manual::WithObjectPad - using Sub::HandlesVia with Object::Pad

Author

       Toby Inkster <tobyink@cpan.org>.

Bugs

       Please report any bugs to <https://github.com/tobyink/p5-sub-handlesvia/issues>.

Disclaimer Of Warranties

       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.

perl v5.40.1                                       2025-04-01             Sub::HandlesVia...::WithObjectPad(3pm)

Manual

       Sub::HandlesVia allows you to delegate methods from your class to the values of your objects' attributes.

       Conceptually, it allows you to define "$object->push_number($n)" to be a shortcut for
       "$object->numbers->push($n)" except that "$object->numbers" is an arrayref, so doesn't have methods you
       can call on it like "push".

       Experimental Object::Pad support is provided by Sub::HandlesVia, including for array and hash fields.

       Object::Pad classes are "sealed" after compile time, preventing new methods from being installed at run-
       time. (It's actually trivially easy to add them at runtime, but not using the API provided by the
       Object::Pad MOP, so we don't do that.) This is why Sub::Handles::Declare is used, as it creates delegated
       methods at compile-time.

       The first argument is the field name, including its sigil.

       The second argument is the handler library. If the field name begins with a '@' or '%', this is implied
       to be "Array"/"Hash".

        use Object::Pad;

        class Kitchen {
          field @foods;
          use Sub::HandlesVia::Declare '@foods', (
            all_foods => 'all',
            add_food  => 'push',
          );
        }

       The third argument is a hash of methods to delegate.

   WhichMethodsCanBeDelegatedTo?
       The second parameter ("Array" in the synopsis) indicates which library of methods should be available.
       Valid values include Array, Blessed, Bool, Code, Counter, Enum, Hash, Number, Scalar, and String.

       An arrayref can be provided, though many of the options are conceptually contradictory.

        use Sub::HandlesVia::Declare 'num', [ 'Number', 'Scalar' ] => (
          ...,
        );

Name

       Sub::HandlesVia::Manual::WithObjectPad - using Sub::HandlesVia with Object::Pad

See Also

       Misc advanced documentation: Sub::HandlesVia::Manual::Advanced.

       Sub::HandlesVia, Sub::HandlesVia::Declare.

       Documentation for delegatable methods: Sub::HandlesVia::HandlerLibrary::Array,
       Sub::HandlesVia::HandlerLibrary::Blessed, Sub::HandlesVia::HandlerLibrary::Bool,
       Sub::HandlesVia::HandlerLibrary::Code, Sub::HandlesVia::HandlerLibrary::Counter,
       Sub::HandlesVia::HandlerLibrary::Enum, Sub::HandlesVia::HandlerLibrary::Hash,
       Sub::HandlesVia::HandlerLibrary::Number, Sub::HandlesVia::HandlerLibrary::Scalar, and
       Sub::HandlesVia::HandlerLibrary::String.

Synopsis

        use Object::Pad;

        class Kitchen {
          field @foods;
          use Sub::HandlesVia::Declare '@foods', Array => (
            all_foods => 'all',
            add_food  => 'push',
          );
        }

See Also