File Coverage

blib/lib/Alien/zstd.pm

Criterion	Covered	Total	%
statement	11	11	100.0
branch			n/a
condition			n/a
subroutine	4	4	100.0
pod			n/a
total	15	15	100.0

package Alien::zstd;

use strict;
use warnings;
use base qw( Alien::Base );
use 5.008004;

1;

=head1 NAME

Alien::zstd - Find or build zstd

=head1 SYNOPSIS

From L:

 use ExtUtils::MakeMaker;
 use Alien::Base::Wrapper ();

 WriteMakefile(
   Alien::Base::Wrapper->new('Alien::zstd')->mm_args2(
     NAME => 'FOO::XS',
     ...
   ),
 );

From L:

 use Module::Build;
 use Alien::Base::Wrapper qw( Alien::zstd !export );
 use Alien::zstd;

 my $build = Module::Build->new(
   ...
   configure_requires => {
     'Alien::Base::Wrapper' => '0',
     'Alien::zstd' => '0',
     ...
   },
   Alien::Base::Wrapper->mb_args,
   ...
 );

 $build->create_build_script;

From L / L script:

 use Inline 0.56 with => 'Alien::zstd';

From L

 [@Filter]
 -bundle = @Basic
 -remove = MakeMaker

 [Prereqs / ConfigureRequires]
 Alien::zstd = 0

 [MakeMaker::Awesome]
 header = use Alien::Base::Wrapper qw( Alien::zstd !export );
 WriteMakefile_arg = Alien::Base::Wrapper->mm_args

From L:

 use FFI::Platypus;
 use Alien::zstd;

 my $ffi = FFI::Platypus->new(
   lib => [ Alien::zstd->dynamic_libs ],
 );

Command line tool:

 use Alien::zstd;
 use Env qw( @PATH );

 unshift @PATH, Alien::zstd->bin_dir;

=head1 DESCRIPTION

This distribution provides zstd so that it can be used by other
Perl distributions that are on CPAN.  It does this by first trying to
detect an existing install of zstd on your system.  If found it
will use that.  If it cannot be found, the source code will be downloaded
from the internet and it will be installed in a private share location
for the use of other modules.

=head1 SEE ALSO

=over 4

=item L

The zstd home page.

=item L

Documentation on the Alien concept itself.

=item L

The base class for this Alien.

=item L

Detailed manual for users of Alien classes.

=back

=cut