Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Module::Loaded (3)

Name

Module::Loaded - mark modules as loaded or unloaded

Synopsis

use Module::Loaded;

$bool = mark_as_loaded('Foo');   # Foo.pm is now marked as loaded
$loc  = is_loaded('Foo');        # location of Foo.pm set to the
# loaders location
eval "require 'Foo'";            # is now a no-op

$bool = mark_as_unloaded('Foo'); # Foo.pm no longer marked as loaded
eval "require 'Foo'";            # Will try to find Foo.pm in @INC

Description

Perl Programmers Reference Guide                             Module::Loaded(3)



NAME
       Module::Loaded - mark modules as loaded or unloaded

SYNOPSIS
           use Module::Loaded;

           $bool = mark_as_loaded('Foo');   # Foo.pm is now marked as loaded
           $loc  = is_loaded('Foo');        # location of Foo.pm set to the
                                            # loaders location
           eval "require 'Foo'";            # is now a no-op

           $bool = mark_as_unloaded('Foo'); # Foo.pm no longer marked as loaded
           eval "require 'Foo'";            # Will try to find Foo.pm in @INC

DESCRIPTION
       When testing applications, often you find yourself needing to provide
       functionality in your test environment that would usually be provided
       by external modules. Rather than munging the %INC by hand to mark these
       external modules as loaded, so they are not attempted to be loaded by
       perl, this module offers you a very simple way to mark modules as
       loaded and/or unloaded.

FUNCTIONS
   $bool = mark_as_loaded( PACKAGE );
       Marks the package as loaded to perl. "PACKAGE" can be a bareword or
       string.

       If the module is already loaded, "mark_as_loaded" will carp about this
       and tell you from where the "PACKAGE" has been loaded already.

   $bool = mark_as_unloaded( PACKAGE );
       Marks the package as unloaded to perl, which is the exact opposite of
       "mark_as_loaded". "PACKAGE" can be a bareword or string.

       If the module is already unloaded, "mark_as_unloaded" will carp about
       this and tell you the "PACKAGE" has been unloaded already.

   $loc = is_loaded( PACKAGE );
       "is_loaded" tells you if "PACKAGE" has been marked as loaded yet.
       "PACKAGE" can be a bareword or string.

       It returns falls if "PACKAGE" has not been loaded yet and the location
       from where it is said to be loaded on success.

BUG REPORTS
       Please report bugs or other issues to
       <bug-module-loaded@rt.cpan.org<gt>.

AUTHOR
       This module by Jos Boumans <kane@cpan.org>.

COPYRIGHT
       This library is free software; you may redistribute and/or modify it
       under the same terms as Perl itself.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-532      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.perl.org/.



perl v5.32.0                      2020-06-14                 Module::Loaded(3)