Perl Diver 2.31
Main Environment Variables Perl Default Values Perl Config - Summary Perl Config - Full Installed Modules List Directory uptime Docs

Module Documentation
Details and documentation about a specific module, including version and documentation (if available). Note that while links to perldoc.com and search.cpan.org are provided, the module may be part of a larger distribution. If you reach a File Not Found page on either site, please try the parent module.

Specio::Exporter

Name Specio::Exporter
Version 0.42
Located at /usr/share/perl5/vendor_perl
File /usr/share/perl5/vendor_perl/Specio/Exporter.pm
Is Core No
Search CPAN for this module Specio::Exporter
Documentation Specio::Exporter
Module Details Specio::Exporter


NAME

Specio::Exporter - Base class for type libraries


VERSION

version 0.42


SYNOPSIS

    package MyApp::Type::Library;
    use parent 'Specio::Exporter';
    use Specio::Declare;
    declare( ... );
    # more types here
    package MyApp::Foo;
    use MyApp::Type::Library


DESCRIPTION

Inheriting from this package makes your package a type exporter. By default, types defined in a package are never visible outside of the package. When you inherit from this package, all the types you define internally become available via exports.

The exported types are available through the importing package's t subroutine.

By default, types your package imports are not re-exported:

  package MyApp::Type::Library;
  use parent 'Specio::Exporter';
  use Specio::Declare;
  use Specio::Library::Builtins;

In this case, the types provided by the Specio::Library::Builtins manpage are not exported to packages which use MyApp::Type::Library.

You can explicitly ask for types to be re-exported:

  package MyApp::Type::Library;
  use parent 'Specio::Exporter';
  use Specio::Declare;
  use Specio::Library::Builtins -reexport;

In this case, packages which use MyApp::Type::Library will get all the types from the Specio::Library::Builtins manpage as well as any types defined in MyApp::Type::Library.


ADDITIONAL EXPORTS

If you want to export some additional subroutines from a package which has Specio::Exporter as its parent, define a sub named _also_export. This sub should return a list of subroutines defined in your package that should also be exported. These subs will be exported unconditionally to any package that uses your package.


COMBINING LIBRARIES WITH the Specio::Subs manpage

You can combine loading libraries with subroutine generation using the Specio::Subs manpage by using _also_export and Specio::Subs::subs_installed_into:

    package My::Library;
    use My::Library::Internal -reexport;
    use Specio::Library::Builtins -reexport;
    use Specio::Subs qw( My::Library::Internal Specio::Library::Builtins );
    sub _also_export {
        return Specio::Subs::subs_installed_into(__PACKAGE__);
    }


SUPPORT

Bugs may be submitted at https://github.com/houseabsolute/Specio/issues.

I am also usually active on IRC as 'autarch' on irc://irc.perl.org.


SOURCE

The source code repository for Specio can be found at https://github.com/houseabsolute/Specio.


AUTHOR

Dave Rolsky <autarch@urth.org>


COPYRIGHT AND LICENSE

This software is Copyright (c) 2012 - 2017 by Dave Rolsky.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)

The full text of the license can be found in the LICENSE file included with this distribution.

Perl Diver brought to you by ScriptSolutions.com © 1997- 2024