• NAME
• VERSION
• SYNOPSIS
• DESCRIPTION
• SUBROUTINES
  • find_containers
  • find_container_path
• SEE ALSO
• AUTHOR
• COPYRIGHT AND LICENSE

NAME

Beam::Runner::Util - Utilities for Beam::Runner command classes

VERSION

version 0.016

SYNOPSIS

    use Beam::Runner::Util qw( find_container_path );

    my $path = find_container_path( $container_name );

DESCRIPTION

This module has some shared utility functions for creating Beam::Runner::Command classes.

SUBROUTINES

find_containers

    my %container = find_containers();

Returns a list of name and path pairs pointing to all the containers in the BEAM_PATH paths.

find_container_path

    my $path = find_container_path( $container_name );

Find the path to the given container. If the given container is already an absolute path, it is simply returned. Otherwise, the container is searched for in the directories defined by the BEAM_PATH environment variable.

If the container cannot be found, throws an exception with a user-friendly error message.

SEE ALSO

Beam::Runner, beam, Exporter

AUTHOR

Doug Bell <preaction@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Doug Bell.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.