CPAN::Meta::Requirements - a set of version requirements for a CPAN dist

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>CPAN::Meta::Requirements - a set of version requirements for a CPAN dist - Perldoc Browser</title> <link rel="search" href="/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser"> <link rel="canonical" href="https://perldoc.perl.org/CPAN::Meta::Requirements"> <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous"> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" /> <style> body { background: #f4f4f5; color: #020202; } .navbar-dark { background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%); background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%); background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%); filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0); background-repeat: repeat-x; } .navbar-dark .navbar-nav .nav-link, .navbar-dark .navbar-nav .nav-link:focus { color: #fff } .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 } #wrapperlicious { margin: 0 auto; font: 0.9em 'Helvetica Neue', Helvetica, sans-serif; font-weight: normal; line-height: 1.5em; margin: 0; padding: 0; } #wrapperlicious h1 { font-size: 1.5em } #wrapperlicious h2 { font-size: 1.3em } #wrapperlicious h3 { font-size: 1.1em } #wrapperlicious h4 { font-size: 0.9em } #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3, #wrapperlicious h4, #wrapperlicious dt { color: #020202; margin-top: 1em; margin-bottom: 1em; position: relative; font-weight: bold; } #wrapperlicious a { color: inherit; text-decoration: underline } #wrapperlicious #toc { text-decoration: none } #wrapperlicious a:hover { color: #2a2a2a } #wrapperlicious a img { border: 0 } #wrapperlicious :not(pre) > code { color: inherit; background-color: rgba(0, 0, 0, 0.04); border-radius: 3px; font: 0.9em Consolas, Menlo, Monaco, monospace; padding: 0.3em; } #wrapperlicious dd { margin: 0; margin-left: 2em; } #wrapperlicious dt { color: #2a2a2a; font-weight: bold; margin-left: 0.9em; } #wrapperlicious p { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious li > p { margin-bottom: 0; margin-top: 0; } #wrapperlicious pre { border: 1px solid #c1c1c1; border-radius: 3px; font: 100% Consolas, Menlo, Monaco, monospace; margin-bottom: 1em; margin-top: 1em; } #wrapperlicious pre > code { display: block; background-color: #f6f6f6; font: 0.9em Consolas, Menlo, Monaco, monospace; line-height: 1.5em; text-align: left; white-space: pre; padding: 1em; } #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious ul { list-style-type: square; } #wrapperlicious ul ul { margin-bottom: 0px; margin-top: 0px; } #footer { font-size: 0.8em; padding-top: 0.5em; text-align: center; } #more { display: inline; font-size: 0.8em; } #perldocdiv { background-color: #fff; border: 1px solid #c1c1c1; border-bottom-left-radius: 5px; border-bottom-right-radius: 5px; margin-left: auto; margin-right: auto; padding: 3em; padding-top: 1em; max-width: 960px; } #moduleversion { float: right } #wrapperlicious .leading-notice { font-style: italic; padding-left: 1em; margin-top: 1em; margin-bottom: 1em; } #wrapperlicious .permalink { display: none; left: -0.75em; position: absolute; padding-right: 0.25em; text-decoration: none; } #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink, #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink, #wrapperlicious dt:hover .permalink { display: block; } </style>  <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-KVNWBNT5FB'); gtag('config', 'UA-50555-3'); </script> </head> <body> <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between"> <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> <a class="navbar-brand" href="/"><img src="/images/perl_camel_30.png" width="30" height="30" class="d-inline-block align-top" alt="Perl Camel Logo"> Perldoc Browser</a> <div class="collapse navbar-collapse" id="navbarNav"> <ul class="navbar-nav mr-auto"> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.28.2</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-stable"> <a class="dropdown-item" href="/CPAN::Meta::Requirements">Latest</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1/CPAN::Meta::Requirements">5.40.1</a> <a class="dropdown-item" href="/5.40.0/CPAN::Meta::Requirements">5.40.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3/CPAN::Meta::Requirements">5.38.3</a> <a class="dropdown-item" href="/5.38.2/CPAN::Meta::Requirements">5.38.2</a> <a class="dropdown-item" href="/5.38.1/CPAN::Meta::Requirements">5.38.1</a> <a class="dropdown-item" href="/5.38.0/CPAN::Meta::Requirements">5.38.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.36.3/CPAN::Meta::Requirements">5.36.3</a> <a class="dropdown-item" href="/5.36.2/CPAN::Meta::Requirements">5.36.2</a> <a class="dropdown-item" href="/5.36.1/CPAN::Meta::Requirements">5.36.1</a> <a class="dropdown-item" href="/5.36.0/CPAN::Meta::Requirements">5.36.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.34.3/CPAN::Meta::Requirements">5.34.3</a> <a class="dropdown-item" href="/5.34.2/CPAN::Meta::Requirements">5.34.2</a> <a class="dropdown-item" href="/5.34.1/CPAN::Meta::Requirements">5.34.1</a> <a class="dropdown-item" href="/5.34.0/CPAN::Meta::Requirements">5.34.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.32.1/CPAN::Meta::Requirements">5.32.1</a> <a class="dropdown-item" href="/5.32.0/CPAN::Meta::Requirements">5.32.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.30.3/CPAN::Meta::Requirements">5.30.3</a> <a class="dropdown-item" href="/5.30.2/CPAN::Meta::Requirements">5.30.2</a> <a class="dropdown-item" href="/5.30.1/CPAN::Meta::Requirements">5.30.1</a> <a class="dropdown-item" href="/5.30.0/CPAN::Meta::Requirements">5.30.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.28.3/CPAN::Meta::Requirements">5.28.3</a> <a class="dropdown-item active" href="/5.28.2/CPAN::Meta::Requirements">5.28.2</a> <a class="dropdown-item" href="/5.28.1/CPAN::Meta::Requirements">5.28.1</a> <a class="dropdown-item" href="/5.28.0/CPAN::Meta::Requirements">5.28.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.26.3/CPAN::Meta::Requirements">5.26.3</a> <a class="dropdown-item" href="/5.26.2/CPAN::Meta::Requirements">5.26.2</a> <a class="dropdown-item" href="/5.26.1/CPAN::Meta::Requirements">5.26.1</a> <a class="dropdown-item" href="/5.26.0/CPAN::Meta::Requirements">5.26.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.24.4/CPAN::Meta::Requirements">5.24.4</a> <a class="dropdown-item" href="/5.24.3/CPAN::Meta::Requirements">5.24.3</a> <a class="dropdown-item" href="/5.24.2/CPAN::Meta::Requirements">5.24.2</a> <a class="dropdown-item" href="/5.24.1/CPAN::Meta::Requirements">5.24.1</a> <a class="dropdown-item" href="/5.24.0/CPAN::Meta::Requirements">5.24.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.22.4/CPAN::Meta::Requirements">5.22.4</a> <a class="dropdown-item" href="/5.22.3/CPAN::Meta::Requirements">5.22.3</a> <a class="dropdown-item" href="/5.22.2/CPAN::Meta::Requirements">5.22.2</a> <a class="dropdown-item" href="/5.22.1/CPAN::Meta::Requirements">5.22.1</a> <a class="dropdown-item" href="/5.22.0/CPAN::Meta::Requirements">5.22.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.20.3/CPAN::Meta::Requirements">5.20.3</a> <a class="dropdown-item" href="/5.20.2/CPAN::Meta::Requirements">5.20.2</a> <a class="dropdown-item" href="/5.20.1/CPAN::Meta::Requirements">5.20.1</a> <a class="dropdown-item" href="/5.20.0/CPAN::Meta::Requirements">5.20.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.18.4/CPAN::Meta::Requirements">5.18.4</a> <a class="dropdown-item" href="/5.18.3/CPAN::Meta::Requirements">5.18.3</a> <a class="dropdown-item" href="/5.18.2/CPAN::Meta::Requirements">5.18.2</a> <a class="dropdown-item" href="/5.18.1/CPAN::Meta::Requirements">5.18.1</a> <a class="dropdown-item" href="/5.18.0/CPAN::Meta::Requirements">5.18.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.16.3/CPAN::Meta::Requirements">5.16.3</a> <a class="dropdown-item" href="/5.16.2/CPAN::Meta::Requirements">5.16.2</a> <a class="dropdown-item" href="/5.16.1/CPAN::Meta::Requirements">5.16.1</a> <a class="dropdown-item" href="/5.16.0/CPAN::Meta::Requirements">5.16.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.14.4/CPAN::Meta::Requirements">5.14.4</a> <a class="dropdown-item" href="/5.14.3/CPAN::Meta::Requirements">5.14.3</a> <a class="dropdown-item" href="/5.14.2/CPAN::Meta::Requirements">5.14.2</a> <a class="dropdown-item" href="/5.14.1/CPAN::Meta::Requirements">5.14.1</a> <a class="dropdown-item" href="/5.14.0/CPAN::Meta::Requirements">5.14.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.12.5/CPAN::Meta::Requirements">5.12.5</a> <a class="dropdown-item" href="/5.12.4/CPAN::Meta::Requirements">5.12.4</a> <a class="dropdown-item" href="/5.12.3/CPAN::Meta::Requirements">5.12.3</a> <a class="dropdown-item" href="/5.12.2/CPAN::Meta::Requirements">5.12.2</a> <a class="dropdown-item" href="/5.12.1/CPAN::Meta::Requirements">5.12.1</a> <a class="dropdown-item" href="/5.12.0/CPAN::Meta::Requirements">5.12.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.10.1/CPAN::Meta::Requirements">5.10.1</a> <a class="dropdown-item" href="/5.10.0/CPAN::Meta::Requirements">5.10.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.8.9/CPAN::Meta::Requirements">5.8.9</a> <a class="dropdown-item" href="/5.8.8/CPAN::Meta::Requirements">5.8.8</a> <a class="dropdown-item" href="/5.8.7/CPAN::Meta::Requirements">5.8.7</a> <a class="dropdown-item" href="/5.8.6/CPAN::Meta::Requirements">5.8.6</a> <a class="dropdown-item" href="/5.8.5/CPAN::Meta::Requirements">5.8.5</a> <a class="dropdown-item" href="/5.8.4/CPAN::Meta::Requirements">5.8.4</a> <a class="dropdown-item" href="/5.8.3/CPAN::Meta::Requirements">5.8.3</a> <a class="dropdown-item" href="/5.8.2/CPAN::Meta::Requirements">5.8.2</a> <a class="dropdown-item" href="/5.8.1/CPAN::Meta::Requirements">5.8.1</a> <a class="dropdown-item" href="/5.8.0/CPAN::Meta::Requirements">5.8.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.6.2/CPAN::Meta::Requirements">5.6.2</a> <a class="dropdown-item" href="/5.6.1/CPAN::Meta::Requirements">5.6.1</a> <a class="dropdown-item" href="/5.6.0/CPAN::Meta::Requirements">5.6.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.005_04/CPAN::Meta::Requirements">5.005_04</a> <a class="dropdown-item" href="/5.005_03/CPAN::Meta::Requirements">5.005_03</a> <a class="dropdown-item" href="/5.005_02/CPAN::Meta::Requirements">5.005_02</a> <a class="dropdown-item" href="/5.005_01/CPAN::Meta::Requirements">5.005_01</a> <a class="dropdown-item" href="/5.005/CPAN::Meta::Requirements">5.005</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-dev"> <a class="dropdown-item" href="/blead/CPAN::Meta::Requirements">blead</a> <a class="dropdown-item" href="/5.41.10/CPAN::Meta::Requirements">5.41.10</a> <a class="dropdown-item" href="/5.41.9/CPAN::Meta::Requirements">5.41.9</a> <a class="dropdown-item" href="/5.41.8/CPAN::Meta::Requirements">5.41.8</a> <a class="dropdown-item" href="/5.41.7/CPAN::Meta::Requirements">5.41.7</a> <a class="dropdown-item" href="/5.41.6/CPAN::Meta::Requirements">5.41.6</a> <a class="dropdown-item" href="/5.41.5/CPAN::Meta::Requirements">5.41.5</a> <a class="dropdown-item" href="/5.41.4/CPAN::Meta::Requirements">5.41.4</a> <a class="dropdown-item" href="/5.41.3/CPAN::Meta::Requirements">5.41.3</a> <a class="dropdown-item" href="/5.41.2/CPAN::Meta::Requirements">5.41.2</a> <a class="dropdown-item" href="/5.41.1/CPAN::Meta::Requirements">5.41.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1-RC1/CPAN::Meta::Requirements">5.40.1-RC1</a> <a class="dropdown-item" href="/5.40.0-RC2/CPAN::Meta::Requirements">5.40.0-RC2</a> <a class="dropdown-item" href="/5.40.0-RC1/CPAN::Meta::Requirements">5.40.0-RC1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.39.10/CPAN::Meta::Requirements">5.39.10</a> <a class="dropdown-item" href="/5.39.9/CPAN::Meta::Requirements">5.39.9</a> <a class="dropdown-item" href="/5.39.8/CPAN::Meta::Requirements">5.39.8</a> <a class="dropdown-item" href="/5.39.7/CPAN::Meta::Requirements">5.39.7</a> <a class="dropdown-item" href="/5.39.6/CPAN::Meta::Requirements">5.39.6</a> <a class="dropdown-item" href="/5.39.5/CPAN::Meta::Requirements">5.39.5</a> <a class="dropdown-item" href="/5.39.4/CPAN::Meta::Requirements">5.39.4</a> <a class="dropdown-item" href="/5.39.3/CPAN::Meta::Requirements">5.39.3</a> <a class="dropdown-item" href="/5.39.2/CPAN::Meta::Requirements">5.39.2</a> <a class="dropdown-item" href="/5.39.1/CPAN::Meta::Requirements">5.39.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3-RC1/CPAN::Meta::Requirements">5.38.3-RC1</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-nav"> <a class="dropdown-item" href="/5.28.2/perl">Perl</a> <a class="dropdown-item" href="/5.28.2/perlintro">Intro</a> <a class="dropdown-item" href="/5.28.2/perl#Tutorials">Tutorials</a> <a class="dropdown-item" href="/5.28.2/perlfaq">FAQs</a> <a class="dropdown-item" href="/5.28.2/perl#Reference-Manual">Reference</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.28.2/perlop">Operators</a> <a class="dropdown-item" href="/5.28.2/functions">Functions</a> <a class="dropdown-item" href="/5.28.2/variables">Variables</a> <a class="dropdown-item" href="/5.28.2/modules">Modules</a> <a class="dropdown-item" href="/5.28.2/perlutil">Utilities</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.28.2/perldelta">Release Notes</a> <a class="dropdown-item" href="/5.28.2/perlcommunity">Community</a> <a class="dropdown-item" href="/5.28.2/perlhist">History</a> </div> </li> </ul> <ul class="navbar-nav"> <script> function set_expand (expand) { var perldocdiv = document.getElementById('perldocdiv'); var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width'); var expanded = (width == '' || width == 'none') ? true : false; if (expand === null) { expand = !expanded; } if ((expand && !expanded) || (!expand && expanded)) { perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px'); var button_classlist = document.getElementById('content-expand-button').classList; if (expand) { button_classlist.add('btn-light'); button_classlist.remove('btn-outline-light'); } else { button_classlist.add('btn-outline-light'); button_classlist.remove('btn-light'); } } return expand; } function toggle_expand () { var expand = set_expand(null); document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC'; } function read_expand () { return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 }); } if (document.readyState === 'loading') { document.addEventListener('DOMContentLoaded', function () { if (read_expand()) { set_expand(true); } }); } else if (read_expand()) { set_expand(true); } </script> <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-4" onclick="toggle_expand()">Expand</button> </ul> <form class="form-inline" method="get" action="/5.28.2/search"> <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search" value=""> </form> </div> </nav> <div id="wrapperlicious" class="container-fluid"> <div id="perldocdiv"> <div id="links"> <a href="/5.28.2/CPAN::Meta::Requirements">CPAN::Meta::Requirements</a> <div id="more"> (<a href="/5.28.2/CPAN::Meta::Requirements.txt">source</a>, <a href="https://metacpan.org/pod/CPAN::Meta::Requirements">CPAN</a>) </div> <div id="moduleversion">version 2.140</div> </div> <div class="leading-notice"> You are viewing the version of this documentation from Perl 5.28.2. <a href="/CPAN::Meta::Requirements">View the latest version</a> </div> <h1><a id="toc">CONTENTS</a></h1> <ul> <li> <a class="text-decoration-none" href="#NAME">NAME</a> </li> <li> <a class="text-decoration-none" href="#VERSION">VERSION</a> </li> <li> <a class="text-decoration-none" href="#SYNOPSIS">SYNOPSIS</a> </li> <li> <a class="text-decoration-none" href="#DESCRIPTION">DESCRIPTION</a> </li> <li> <a class="text-decoration-none" href="#METHODS">METHODS</a> <ul> <li> <a class="text-decoration-none" href="#new">new</a> </li> <li> <a class="text-decoration-none" href="#add_minimum">add_minimum</a> </li> <li> <a class="text-decoration-none" href="#add_maximum">add_maximum</a> </li> <li> <a class="text-decoration-none" href="#add_exclusion">add_exclusion</a> </li> <li> <a class="text-decoration-none" href="#exact_version">exact_version</a> </li> <li> <a class="text-decoration-none" href="#add_requirements">add_requirements</a> </li> <li> <a class="text-decoration-none" href="#accepts_module">accepts_module</a> </li> <li> <a class="text-decoration-none" href="#clear_requirement">clear_requirement</a> </li> <li> <a class="text-decoration-none" href="#requirements_for_module">requirements_for_module</a> </li> <li> <a class="text-decoration-none" href="#structured_requirements_for_module">structured_requirements_for_module</a> </li> <li> <a class="text-decoration-none" href="#required_modules">required_modules</a> </li> <li> <a class="text-decoration-none" href="#clone">clone</a> </li> <li> <a class="text-decoration-none" href="#is_simple">is_simple</a> </li> <li> <a class="text-decoration-none" href="#is_finalized">is_finalized</a> </li> <li> <a class="text-decoration-none" href="#finalize">finalize</a> </li> <li> <a class="text-decoration-none" href="#as_string_hash">as_string_hash</a> </li> <li> <a class="text-decoration-none" href="#add_string_requirement">add_string_requirement</a> </li> <li> <a class="text-decoration-none" href="#from_string_hash">from_string_hash</a> </li> </ul> </li> <li> <a class="text-decoration-none" href="#SUPPORT">SUPPORT</a> <ul> <li> <a class="text-decoration-none" href="#Bugs-/-Feature-Requests">Bugs / Feature Requests</a> </li> <li> <a class="text-decoration-none" href="#Source-Code">Source Code</a> </li> </ul> </li> <li> <a class="text-decoration-none" href="#AUTHORS">AUTHORS</a> </li> <li> <a class="text-decoration-none" href="#CONTRIBUTORS">CONTRIBUTORS</a> </li> <li> <a class="text-decoration-none" href="#COPYRIGHT-AND-LICENSE">COPYRIGHT AND LICENSE</a> </li> </ul> <h1 id="NAME"><a class="permalink" href="#NAME">#</a>NAME</h1> <p>CPAN::Meta::Requirements - a set of version requirements for a CPAN dist</p> <h1 id="VERSION"><a class="permalink" href="#VERSION">#</a>VERSION</h1> <p>version 2.140</p> <h1 id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">#</a>SYNOPSIS</h1> <pre><code>use CPAN::Meta::Requirements; my $build_requires = CPAN::Meta::Requirements->new; $build_requires->add_minimum('Library::Foo' => 1.208); $build_requires->add_minimum('Library::Foo' => 2.602); $build_requires->add_minimum('Module::Bar' => 'v1.2.3'); $METAyml->{build_requires} = $build_requires->as_string_hash;</code></pre> <h1 id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">#</a>DESCRIPTION</h1> <p>A CPAN::Meta::Requirements object models a set of version constraints like those specified in the <i>META.yml</i> or <i>META.json</i> files in CPAN distributions, and as defined by <a href="/5.28.2/CPAN::Meta::Spec">CPAN::Meta::Spec</a>; It can be built up by adding more and more constraints, and it will reduce them to the simplest representation.</p> <p>Logically impossible constraints will be identified immediately by thrown exceptions.</p> <h1 id="METHODS"><a class="permalink" href="#METHODS">#</a>METHODS</h1> <h2 id="new"><a class="permalink" href="#new">#</a>new</h2> <pre><code>my $req = CPAN::Meta::Requirements->new;</code></pre> <p>This returns a new CPAN::Meta::Requirements object. It takes an optional hash reference argument. Currently, only one key is supported:</p> <ul> <li><p><code>bad_version_hook</code> -- if provided, when a version cannot be parsed into a version object, this code reference will be called with the invalid version string as first argument, and the module name as second argument. It must return a valid version object.</p> </li> </ul> <p>All other keys are ignored.</p> <h2 id="add_minimum"><a class="permalink" href="#add_minimum">#</a>add_minimum</h2> <pre><code>$req->add_minimum( $module => $version );</code></pre> <p>This adds a new minimum version requirement. If the new requirement is redundant to the existing specification, this has no effect.</p> <p>Minimum requirements are inclusive. <code>$version</code> is required, along with any greater version number.</p> <p>This method returns the requirements object.</p> <h2 id="add_maximum"><a class="permalink" href="#add_maximum">#</a>add_maximum</h2> <pre><code>$req->add_maximum( $module => $version );</code></pre> <p>This adds a new maximum version requirement. If the new requirement is redundant to the existing specification, this has no effect.</p> <p>Maximum requirements are inclusive. No version strictly greater than the given version is allowed.</p> <p>This method returns the requirements object.</p> <h2 id="add_exclusion"><a class="permalink" href="#add_exclusion">#</a>add_exclusion</h2> <pre><code>$req->add_exclusion( $module => $version );</code></pre> <p>This adds a new excluded version. For example, you might use these three method calls:</p> <pre><code>$req->add_minimum( $module => '1.00' ); $req->add_maximum( $module => '1.82' ); $req->add_exclusion( $module => '1.75' );</code></pre> <p>Any version between 1.00 and 1.82 inclusive would be acceptable, except for 1.75.</p> <p>This method returns the requirements object.</p> <h2 id="exact_version"><a class="permalink" href="#exact_version">#</a>exact_version</h2> <pre><code>$req->exact_version( $module => $version );</code></pre> <p>This sets the version required for the given module to <i>exactly</i> the given version. No other version would be considered acceptable.</p> <p>This method returns the requirements object.</p> <h2 id="add_requirements"><a class="permalink" href="#add_requirements">#</a>add_requirements</h2> <pre><code>$req->add_requirements( $another_req_object );</code></pre> <p>This method adds all the requirements in the given CPAN::Meta::Requirements object to the requirements object on which it was called. If there are any conflicts, an exception is thrown.</p> <p>This method returns the requirements object.</p> <h2 id="accepts_module"><a class="permalink" href="#accepts_module">#</a>accepts_module</h2> <pre><code>my $bool = $req->accepts_module($module => $version);</code></pre> <p>Given an module and version, this method returns true if the version specification for the module accepts the provided version. In other words, given:</p> <pre><code class="plaintext">Module => '>= 1.00, < 2.00'</code></pre> <p>We will accept 1.00 and 1.75 but not 0.50 or 2.00.</p> <p>For modules that do not appear in the requirements, this method will return true.</p> <h2 id="clear_requirement"><a class="permalink" href="#clear_requirement">#</a>clear_requirement</h2> <pre><code>$req->clear_requirement( $module );</code></pre> <p>This removes the requirement for a given module from the object.</p> <p>This method returns the requirements object.</p> <h2 id="requirements_for_module"><a class="permalink" href="#requirements_for_module">#</a>requirements_for_module</h2> <pre><code>$req->requirements_for_module( $module );</code></pre> <p>This returns a string containing the version requirements for a given module in the format described in <a href="/5.28.2/CPAN::Meta::Spec">CPAN::Meta::Spec</a> or undef if the given module has no requirements. This should only be used for informational purposes such as error messages and should not be interpreted or used for comparison (see <a href="#accepts_module">"accepts_module"</a> instead).</p> <h2 id="structured_requirements_for_module"><a class="permalink" href="#structured_requirements_for_module">#</a>structured_requirements_for_module</h2> <pre><code>$req->structured_requirements_for_module( $module );</code></pre> <p>This returns a data structure containing the version requirements for a given module or undef if the given module has no requirements. This should not be used for version checks (see <a href="#accepts_module">"accepts_module"</a> instead).</p> <p>Added in version 2.134.</p> <h2 id="required_modules"><a class="permalink" href="#required_modules">#</a>required_modules</h2> <p>This method returns a list of all the modules for which requirements have been specified.</p> <h2 id="clone"><a class="permalink" href="#clone">#</a>clone</h2> <pre><code>$req->clone;</code></pre> <p>This method returns a clone of the invocant. The clone and the original object can then be changed independent of one another.</p> <h2 id="is_simple"><a class="permalink" href="#is_simple">#</a>is_simple</h2> <p>This method returns true if and only if all requirements are inclusive minimums -- that is, if their string expression is just the version number.</p> <h2 id="is_finalized"><a class="permalink" href="#is_finalized">#</a>is_finalized</h2> <p>This method returns true if the requirements have been finalized by having the <code>finalize</code> method called on them.</p> <h2 id="finalize"><a class="permalink" href="#finalize">#</a>finalize</h2> <p>This method marks the requirements finalized. Subsequent attempts to change the requirements will be fatal, <i>if</i> they would result in a change. If they would not alter the requirements, they have no effect.</p> <p>If a finalized set of requirements is cloned, the cloned requirements are not also finalized.</p> <h2 id="as_string_hash"><a class="permalink" href="#as_string_hash">#</a>as_string_hash</h2> <p>This returns a reference to a hash describing the requirements using the strings in the <a href="/5.28.2/CPAN::Meta::Spec">CPAN::Meta::Spec</a> specification.</p> <p>For example after the following program:</p> <pre><code>my $req = CPAN::Meta::Requirements->new; $req->add_minimum('CPAN::Meta::Requirements' => 0.102); $req->add_minimum('Library::Foo' => 1.208); $req->add_maximum('Library::Foo' => 2.602); $req->add_minimum('Module::Bar' => 'v1.2.3'); $req->add_exclusion('Module::Bar' => 'v1.2.8'); $req->exact_version('Xyzzy' => '6.01'); my $hashref = $req->as_string_hash;</code></pre> <p><code>$hashref</code> would contain:</p> <pre><code>{ 'CPAN::Meta::Requirements' => '0.102', 'Library::Foo' => '>= 1.208, <= 2.206', 'Module::Bar' => '>= v1.2.3, != v1.2.8', 'Xyzzy' => '== 6.01', }</code></pre> <h2 id="add_string_requirement"><a class="permalink" href="#add_string_requirement">#</a>add_string_requirement</h2> <pre><code>$req->add_string_requirement('Library::Foo' => '>= 1.208, <= 2.206'); $req->add_string_requirement('Library::Foo' => v1.208);</code></pre> <p>This method parses the passed in string and adds the appropriate requirement for the given module. A version can be a Perl "v-string". It understands version ranges as described in the <a href="/5.28.2/CPAN::Meta::Spec#Version-Ranges">"Version Ranges" in CPAN::Meta::Spec</a>. For example:</p> <dl> <dt id="1.3"><a class="permalink" href="#1.3">#</a><a id="1"></a><a id="pod1.3"></a>1.3</dt> <dd> </dd> <dt id=">=-1.3"><a class="permalink" href="#%3E=-1.3">#</a><a id="pod-1.3"></a>>= 1.3</dt> <dd> </dd> <dt id="<=-1.3"><a class="permalink" href="#%3C=-1.3">#</a><a id="pod-1.31"></a><= 1.3</dt> <dd> </dd> <dt id="==-1.3"><a class="permalink" href="#==-1.3">#</a><a id="pod-1.32"></a>== 1.3</dt> <dd> </dd> <dt id="!=-1.3"><a class="permalink" href="#!=-1.3">#</a><a id="pod-1.33"></a>!= 1.3</dt> <dd> </dd> <dt id=">-1.3"><a class="permalink" href="#%3E-1.3">#</a><a id="pod1.31"></a>> 1.3</dt> <dd> </dd> <dt id="<-1.3"><a class="permalink" href="#%3C-1.3">#</a><a id="pod1.32"></a>< 1.3</dt> <dd> </dd> <dt id=">=-1.3,-!=-1.5,-<=-2.0"><a class="permalink" href="#%3E=-1.3,-!=-1.5,-%3C=-2.0">#</a><a id="pod-1.3-1.5-2.0"></a>>= 1.3, != 1.5, <= 2.0</dt> <dd> <p>A version number without an operator is equivalent to specifying a minimum (<code>>=</code>). Extra whitespace is allowed.</p> </dd> </dl> <h2 id="from_string_hash"><a class="permalink" href="#from_string_hash">#</a>from_string_hash</h2> <pre><code>my $req = CPAN::Meta::Requirements->from_string_hash( \%hash ); my $req = CPAN::Meta::Requirements->from_string_hash( \%hash, \%opts );</code></pre> <p>This is an alternate constructor for a CPAN::Meta::Requirements object. It takes a hash of module names and version requirement strings and returns a new CPAN::Meta::Requirements object. As with add_string_requirement, a version can be a Perl "v-string". Optionally, you can supply a hash-reference of options, exactly as with the <a href="#new">"new"</a> method.</p> <h1 id="SUPPORT"><a class="permalink" href="#SUPPORT">#</a>SUPPORT</h1> <h2 id="Bugs-/-Feature-Requests"><a class="permalink" href="#Bugs-/-Feature-Requests">#</a><a id="Bugs"></a><a id="Bugs-Feature-Requests"></a>Bugs / Feature Requests</h2> <p>Please report any bugs or feature requests through the issue tracker at <a href="https://github.com/Perl-Toolchain-Gang/CPAN-Meta-Requirements/issues">https://github.com/Perl-Toolchain-Gang/CPAN-Meta-Requirements/issues</a>. You will be notified automatically of any progress on your issue.</p> <h2 id="Source-Code"><a class="permalink" href="#Source-Code">#</a><a id="Source"></a>Source Code</h2> <p>This is open source software. The code repository is available for public review and contribution under the terms of the license.</p> <p><a href="https://github.com/Perl-Toolchain-Gang/CPAN-Meta-Requirements">https://github.com/Perl-Toolchain-Gang/CPAN-Meta-Requirements</a></p> <pre><code class="plaintext">git clone https://github.com/Perl-Toolchain-Gang/CPAN-Meta-Requirements.git</code></pre> <h1 id="AUTHORS"><a class="permalink" href="#AUTHORS">#</a>AUTHORS</h1> <ul> <li><p>David Golden <dagolden@cpan.org></p> </li> <li><p>Ricardo Signes <rjbs@cpan.org></p> </li> </ul> <h1 id="CONTRIBUTORS"><a class="permalink" href="#CONTRIBUTORS">#</a>CONTRIBUTORS</h1> <ul> <li><p>Ed J <mohawk2@users.noreply.github.com></p> </li> <li><p>Karen Etheridge <ether@cpan.org></p> </li> <li><p>Leon Timmermans <fawaka@gmail.com></p> </li> <li><p>robario <webmaster@robario.com></p> </li> </ul> <h1 id="COPYRIGHT-AND-LICENSE"><a class="permalink" href="#COPYRIGHT-AND-LICENSE">#</a><a id="COPYRIGHT"></a>COPYRIGHT AND LICENSE</h1> <p>This software is copyright (c) 2010 by David Golden and Ricardo Signes.</p> <p>This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.</p> </div> <div id="footer"> <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p> <p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p> </div> </div> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script> <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script> <script src="/js/highlight.pack.js"></script> <script>hljs.highlightAll();</script> </body> </html>

CINXE.COM

CPAN::Meta::Requirements - a set of version requirements for a CPAN dist - Perldoc Browser