NAME¶

Specio::Exporter - Base class for type libraries

VERSION¶

version 0.48

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 Specio::Library::Builtins 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 Specio::Library::Builtins 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 Specio::Subs¶

You can combine loading libraries with subroutine generation using Specio::Subs 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>.

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 - 2022 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.