/ 
Acme-CPANModules-XSVersions-0.003
River stage one • 1 direct dependent • 1 total dependent
/ Acme::CPANModules::XSVersions

NAME

Acme::CPANModules::XSVersions - List of XS versions of Perl modules

VERSION

This document describes version 0.003 of Acme::CPANModules::XSVersions (from Perl distribution Acme-CPANModules-XSVersions), released on 2022-03-18.

SYNOPSIS

To install all XS versions of PP modules currently installed on your system:

% perl -MAcme::CM::Get=XSVersions -MModule::Installed::Tiny=module_installed -E'for (@{$LIST->{entries}}) {
      next unless module_installed($_->{module}) || $_->{pp_module} && module_installed($_->{pp_module});
      say $_->{xs_module};
  }' | cpanm -n

(Note: To run the above snippet, you need to install Acme::CPANModules::XSVersions which you're reading right now, as well as Acme::CM::Get, Module::Installed::Tiny, and cpanm.)

DESCRIPTION

This list catalogs (pure-) Perl modules that have their XS counterparts ("fast versions"), usually in separate distributions so the installation of the XS version is optional. The two versions of the modules provide the same interface. When the two modules are different in interface, they are not listed here.

Usually authors use ::XS or _XS suffix for the XS version (for example, Type::Tiny is the PP/pure-perl version and Type::Tiny::XS is the XS version). Or sometimes the other way around is done, a module is an XS module and another with suffix ::PP or _PP is the PP version. And often a module like JSON is one that can automatically use the XS version (JSON::XS) when it's available or fallback to the PP version (JSON::PP).

Additions much welcome.

ACME::CPANMODULES ENTRIES

FAQ

What is an Acme::CPANModules::* module?

An Acme::CPANModules::* module, like this module, contains just a list of module names that share a common characteristics. It is a way to categorize modules and document CPAN. See Acme::CPANModules for more details.

What are ways to use this Acme::CPANModules module?

Aside from reading this Acme::CPANModules module's POD documentation, you can install all the listed modules (entries) using cpanm-cpanmodules script (from App::cpanm::cpanmodules distribution):

% cpanm-cpanmodules -n XSVersions

Alternatively you can use the cpanmodules CLI (from App::cpanmodules distribution):

% cpanmodules ls-entries XSVersions | cpanm -n

or Acme::CM::Get:

% perl -MAcme::CM::Get=XSVersions -E'say $_->{module} for @{ $LIST->{entries} }' | cpanm -n

or directly:

% perl -MAcme::CPANModules::XSVersions -E'say $_->{module} for @{ $Acme::CPANModules::XSVersions::LIST->{entries} }' | cpanm -n

This Acme::CPANModules module also helps lcpan produce a more meaningful result for lcpan related-mods command when it comes to finding related modules for the modules listed in this Acme::CPANModules module. See App::lcpan::Cmd::related_mods for more details on how "related modules" are found.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Acme-CPANModules-XSVersions.

SOURCE

Source repository is at https://github.com/perlancar/perl-Acme-CPANModules-XSVersions.

SEE ALSO

Acme::CPANModules - about the Acme::CPANModules namespace

cpanmodules - CLI tool to let you browse/view the lists

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2022, 2019 by perlancar <perlancar@cpan.org>.

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

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Acme-CPANModules-XSVersions

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.