Scalar::Util - A selection of general-utility scalar subroutines

<!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>Scalar::Util - A selection of general-utility scalar subroutines - Perldoc Browser</title> <link rel="search" href="/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser"> <link rel="canonical" href="https://perldoc.perl.org/Scalar::Util"> <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.24.4</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-stable"> <a class="dropdown-item" href="/Scalar::Util">Latest</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1/Scalar::Util">5.40.1</a> <a class="dropdown-item" href="/5.40.0/Scalar::Util">5.40.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3/Scalar::Util">5.38.3</a> <a class="dropdown-item" href="/5.38.2/Scalar::Util">5.38.2</a> <a class="dropdown-item" href="/5.38.1/Scalar::Util">5.38.1</a> <a class="dropdown-item" href="/5.38.0/Scalar::Util">5.38.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.36.3/Scalar::Util">5.36.3</a> <a class="dropdown-item" href="/5.36.2/Scalar::Util">5.36.2</a> <a class="dropdown-item" href="/5.36.1/Scalar::Util">5.36.1</a> <a class="dropdown-item" href="/5.36.0/Scalar::Util">5.36.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.34.3/Scalar::Util">5.34.3</a> <a class="dropdown-item" href="/5.34.2/Scalar::Util">5.34.2</a> <a class="dropdown-item" href="/5.34.1/Scalar::Util">5.34.1</a> <a class="dropdown-item" href="/5.34.0/Scalar::Util">5.34.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.32.1/Scalar::Util">5.32.1</a> <a class="dropdown-item" href="/5.32.0/Scalar::Util">5.32.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.30.3/Scalar::Util">5.30.3</a> <a class="dropdown-item" href="/5.30.2/Scalar::Util">5.30.2</a> <a class="dropdown-item" href="/5.30.1/Scalar::Util">5.30.1</a> <a class="dropdown-item" href="/5.30.0/Scalar::Util">5.30.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.28.3/Scalar::Util">5.28.3</a> <a class="dropdown-item" href="/5.28.2/Scalar::Util">5.28.2</a> <a class="dropdown-item" href="/5.28.1/Scalar::Util">5.28.1</a> <a class="dropdown-item" href="/5.28.0/Scalar::Util">5.28.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.26.3/Scalar::Util">5.26.3</a> <a class="dropdown-item" href="/5.26.2/Scalar::Util">5.26.2</a> <a class="dropdown-item" href="/5.26.1/Scalar::Util">5.26.1</a> <a class="dropdown-item" href="/5.26.0/Scalar::Util">5.26.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item active" href="/5.24.4/Scalar::Util">5.24.4</a> <a class="dropdown-item" href="/5.24.3/Scalar::Util">5.24.3</a> <a class="dropdown-item" href="/5.24.2/Scalar::Util">5.24.2</a> <a class="dropdown-item" href="/5.24.1/Scalar::Util">5.24.1</a> <a class="dropdown-item" href="/5.24.0/Scalar::Util">5.24.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.22.4/Scalar::Util">5.22.4</a> <a class="dropdown-item" href="/5.22.3/Scalar::Util">5.22.3</a> <a class="dropdown-item" href="/5.22.2/Scalar::Util">5.22.2</a> <a class="dropdown-item" href="/5.22.1/Scalar::Util">5.22.1</a> <a class="dropdown-item" href="/5.22.0/Scalar::Util">5.22.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.20.3/Scalar::Util">5.20.3</a> <a class="dropdown-item" href="/5.20.2/Scalar::Util">5.20.2</a> <a class="dropdown-item" href="/5.20.1/Scalar::Util">5.20.1</a> <a class="dropdown-item" href="/5.20.0/Scalar::Util">5.20.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.18.4/Scalar::Util">5.18.4</a> <a class="dropdown-item" href="/5.18.3/Scalar::Util">5.18.3</a> <a class="dropdown-item" href="/5.18.2/Scalar::Util">5.18.2</a> <a class="dropdown-item" href="/5.18.1/Scalar::Util">5.18.1</a> <a class="dropdown-item" href="/5.18.0/Scalar::Util">5.18.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.16.3/Scalar::Util">5.16.3</a> <a class="dropdown-item" href="/5.16.2/Scalar::Util">5.16.2</a> <a class="dropdown-item" href="/5.16.1/Scalar::Util">5.16.1</a> <a class="dropdown-item" href="/5.16.0/Scalar::Util">5.16.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.14.4/Scalar::Util">5.14.4</a> <a class="dropdown-item" href="/5.14.3/Scalar::Util">5.14.3</a> <a class="dropdown-item" href="/5.14.2/Scalar::Util">5.14.2</a> <a class="dropdown-item" href="/5.14.1/Scalar::Util">5.14.1</a> <a class="dropdown-item" href="/5.14.0/Scalar::Util">5.14.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.12.5/Scalar::Util">5.12.5</a> <a class="dropdown-item" href="/5.12.4/Scalar::Util">5.12.4</a> <a class="dropdown-item" href="/5.12.3/Scalar::Util">5.12.3</a> <a class="dropdown-item" href="/5.12.2/Scalar::Util">5.12.2</a> <a class="dropdown-item" href="/5.12.1/Scalar::Util">5.12.1</a> <a class="dropdown-item" href="/5.12.0/Scalar::Util">5.12.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.10.1/Scalar::Util">5.10.1</a> <a class="dropdown-item" href="/5.10.0/Scalar::Util">5.10.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.8.9/Scalar::Util">5.8.9</a> <a class="dropdown-item" href="/5.8.8/Scalar::Util">5.8.8</a> <a class="dropdown-item" href="/5.8.7/Scalar::Util">5.8.7</a> <a class="dropdown-item" href="/5.8.6/Scalar::Util">5.8.6</a> <a class="dropdown-item" href="/5.8.5/Scalar::Util">5.8.5</a> <a class="dropdown-item" href="/5.8.4/Scalar::Util">5.8.4</a> <a class="dropdown-item" href="/5.8.3/Scalar::Util">5.8.3</a> <a class="dropdown-item" href="/5.8.2/Scalar::Util">5.8.2</a> <a class="dropdown-item" href="/5.8.1/Scalar::Util">5.8.1</a> <a class="dropdown-item" href="/5.8.0/Scalar::Util">5.8.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.6.2/Scalar::Util">5.6.2</a> <a class="dropdown-item" href="/5.6.1/Scalar::Util">5.6.1</a> <a class="dropdown-item" href="/5.6.0/Scalar::Util">5.6.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.005_04/Scalar::Util">5.005_04</a> <a class="dropdown-item" href="/5.005_03/Scalar::Util">5.005_03</a> <a class="dropdown-item" href="/5.005_02/Scalar::Util">5.005_02</a> <a class="dropdown-item" href="/5.005_01/Scalar::Util">5.005_01</a> <a class="dropdown-item" href="/5.005/Scalar::Util">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/Scalar::Util">blead</a> <a class="dropdown-item" href="/5.41.10/Scalar::Util">5.41.10</a> <a class="dropdown-item" href="/5.41.9/Scalar::Util">5.41.9</a> <a class="dropdown-item" href="/5.41.8/Scalar::Util">5.41.8</a> <a class="dropdown-item" href="/5.41.7/Scalar::Util">5.41.7</a> <a class="dropdown-item" href="/5.41.6/Scalar::Util">5.41.6</a> <a class="dropdown-item" href="/5.41.5/Scalar::Util">5.41.5</a> <a class="dropdown-item" href="/5.41.4/Scalar::Util">5.41.4</a> <a class="dropdown-item" href="/5.41.3/Scalar::Util">5.41.3</a> <a class="dropdown-item" href="/5.41.2/Scalar::Util">5.41.2</a> <a class="dropdown-item" href="/5.41.1/Scalar::Util">5.41.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1-RC1/Scalar::Util">5.40.1-RC1</a> <a class="dropdown-item" href="/5.40.0-RC2/Scalar::Util">5.40.0-RC2</a> <a class="dropdown-item" href="/5.40.0-RC1/Scalar::Util">5.40.0-RC1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.39.10/Scalar::Util">5.39.10</a> <a class="dropdown-item" href="/5.39.9/Scalar::Util">5.39.9</a> <a class="dropdown-item" href="/5.39.8/Scalar::Util">5.39.8</a> <a class="dropdown-item" href="/5.39.7/Scalar::Util">5.39.7</a> <a class="dropdown-item" href="/5.39.6/Scalar::Util">5.39.6</a> <a class="dropdown-item" href="/5.39.5/Scalar::Util">5.39.5</a> <a class="dropdown-item" href="/5.39.4/Scalar::Util">5.39.4</a> <a class="dropdown-item" href="/5.39.3/Scalar::Util">5.39.3</a> <a class="dropdown-item" href="/5.39.2/Scalar::Util">5.39.2</a> <a class="dropdown-item" href="/5.39.1/Scalar::Util">5.39.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3-RC1/Scalar::Util">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.24.4/perl">Perl</a> <a class="dropdown-item" href="/5.24.4/perlintro">Intro</a> <a class="dropdown-item" href="/5.24.4/perl#Tutorials">Tutorials</a> <a class="dropdown-item" href="/5.24.4/perlfaq">FAQs</a> <a class="dropdown-item" href="/5.24.4/perl#Reference-Manual">Reference</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.24.4/perlop">Operators</a> <a class="dropdown-item" href="/5.24.4/functions">Functions</a> <a class="dropdown-item" href="/5.24.4/variables">Variables</a> <a class="dropdown-item" href="/5.24.4/modules">Modules</a> <a class="dropdown-item" href="/5.24.4/perlutil">Utilities</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.24.4/perldelta">Release Notes</a> <a class="dropdown-item" href="/5.24.4/perlcommunity">Community</a> <a class="dropdown-item" href="/5.24.4/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.24.4/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.24.4/Scalar::Util">Scalar::Util</a> <div id="more"> (<a href="/5.24.4/Scalar::Util.txt">source</a>, <a href="https://metacpan.org/pod/Scalar::Util">CPAN</a>) </div> <div id="moduleversion">version 1.42_02</div> </div> <div class="leading-notice"> You are viewing the version of this documentation from Perl 5.24.4. <a href="/Scalar::Util">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="#SYNOPSIS">SYNOPSIS</a> </li> <li> <a class="text-decoration-none" href="#DESCRIPTION">DESCRIPTION</a> </li> <li> <a class="text-decoration-none" href="#FUNCTIONS-FOR-REFERENCES">FUNCTIONS FOR REFERENCES</a> <ul> <li> <a class="text-decoration-none" href="#blessed">blessed</a> </li> <li> <a class="text-decoration-none" href="#refaddr">refaddr</a> </li> <li> <a class="text-decoration-none" href="#reftype">reftype</a> </li> <li> <a class="text-decoration-none" href="#weaken">weaken</a> </li> <li> <a class="text-decoration-none" href="#unweaken">unweaken</a> </li> <li> <a class="text-decoration-none" href="#isweak">isweak</a> </li> </ul> </li> <li> <a class="text-decoration-none" href="#OTHER-FUNCTIONS">OTHER FUNCTIONS</a> <ul> <li> <a class="text-decoration-none" href="#dualvar">dualvar</a> </li> <li> <a class="text-decoration-none" href="#isdual">isdual</a> </li> <li> <a class="text-decoration-none" href="#isvstring">isvstring</a> </li> <li> <a class="text-decoration-none" href="#looks_like_number">looks_like_number</a> </li> <li> <a class="text-decoration-none" href="#openhandle">openhandle</a> </li> <li> <a class="text-decoration-none" href="#readonly">readonly</a> </li> <li> <a class="text-decoration-none" href="#set_prototype">set_prototype</a> </li> <li> <a class="text-decoration-none" href="#tainted">tainted</a> </li> </ul> </li> <li> <a class="text-decoration-none" href="#DIAGNOSTICS">DIAGNOSTICS</a> </li> <li> <a class="text-decoration-none" href="#KNOWN-BUGS">KNOWN BUGS</a> </li> <li> <a class="text-decoration-none" href="#SEE-ALSO">SEE ALSO</a> </li> <li> <a class="text-decoration-none" href="#COPYRIGHT">COPYRIGHT</a> </li> </ul> <h1 id="NAME"><a class="permalink" href="#NAME">#</a>NAME</h1> <p>Scalar::Util - A selection of general-utility scalar subroutines</p> <h1 id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">#</a>SYNOPSIS</h1> <pre><code>use Scalar::Util qw(blessed dualvar isdual readonly refaddr reftype tainted weaken isweak isvstring looks_like_number set_prototype); # and other useful utils appearing below</code></pre> <h1 id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">#</a>DESCRIPTION</h1> <p><code>Scalar::Util</code> contains a selection of subroutines that people have expressed would be nice to have in the perl core, but the usage would not really be high enough to warrant the use of a keyword, and the size so small such that being individual extensions would be wasteful.</p> <p>By default <code>Scalar::Util</code> does not export any subroutines.</p> <h1 id="FUNCTIONS-FOR-REFERENCES"><a class="permalink" href="#FUNCTIONS-FOR-REFERENCES">#</a><a id="FUNCTIONS"></a>FUNCTIONS FOR REFERENCES</h1> <p>The following functions all perform some useful activity on reference values.</p> <h2 id="blessed"><a class="permalink" href="#blessed">#</a>blessed</h2> <pre><code>my $pkg = blessed( $ref );</code></pre> <p>If <code>$ref</code> is a blessed reference the name of the package that it is blessed into is returned. Otherwise <code>undef</code> is returned.</p> <pre><code>$scalar = "foo"; $class = blessed $scalar; # undef $ref = []; $class = blessed $ref; # undef $obj = bless [], "Foo"; $class = blessed $obj; # "Foo"</code></pre> <p>Take care when using this function simply as a truth test (such as in <code>if(blessed $ref)...</code>) because the package name <code>"0"</code> is defined yet false.</p> <h2 id="refaddr"><a class="permalink" href="#refaddr">#</a>refaddr</h2> <pre><code>my $addr = refaddr( $ref );</code></pre> <p>If <code>$ref</code> is reference the internal memory address of the referenced value is returned as a plain integer. Otherwise <code>undef</code> is returned.</p> <pre><code>$addr = refaddr "string"; # undef $addr = refaddr \$var; # eg 12345678 $addr = refaddr []; # eg 23456784 $obj = bless {}, "Foo"; $addr = refaddr $obj; # eg 88123488</code></pre> <h2 id="reftype"><a class="permalink" href="#reftype">#</a>reftype</h2> <pre><code>my $type = reftype( $ref );</code></pre> <p>If <code>$ref</code> is a reference the basic Perl type of the variable referenced is returned as a plain string (such as <code>ARRAY</code> or <code>HASH</code>). Otherwise <code>undef</code> is returned.</p> <pre><code>$type = reftype "string"; # undef $type = reftype \$var; # SCALAR $type = reftype []; # ARRAY $obj = bless {}, "Foo"; $type = reftype $obj; # HASH</code></pre> <h2 id="weaken"><a class="permalink" href="#weaken">#</a>weaken</h2> <pre><code>weaken( $ref );</code></pre> <p>The lvalue <code>$ref</code> will be turned into a weak reference. This means that it will not hold a reference count on the object it references. Also when the reference count on that object reaches zero, the reference will be set to undef. This function mutates the lvalue passed as its argument and returns no value.</p> <p>This is useful for keeping copies of references, but you don't want to prevent the object being DESTROY-ed at its usual time.</p> <pre><code>{ my $var; $ref = \$var; weaken($ref); # Make $ref a weak reference } # $ref is now undef</code></pre> <p>Note that if you take a copy of a scalar with a weakened reference, the copy will be a strong reference.</p> <pre><code>my $var; my $foo = \$var; weaken($foo); # Make $foo a weak reference my $bar = $foo; # $bar is now a strong reference</code></pre> <p>This may be less obvious in other situations, such as <code>grep()</code>, for instance when grepping through a list of weakened references to objects that may have been destroyed already:</p> <pre><code>@object = grep { defined } @object;</code></pre> <p>This will indeed remove all references to destroyed objects, but the remaining references to objects will be strong, causing the remaining objects to never be destroyed because there is now always a strong reference to them in the @object array.</p> <h2 id="unweaken"><a class="permalink" href="#unweaken">#</a>unweaken</h2> <pre><code>unweaken( $ref );</code></pre> <p><i>Since version 1.36.</i></p> <p>The lvalue <code>REF</code> will be turned from a weak reference back into a normal (strong) reference again. This function mutates the lvalue passed as its argument and returns no value. This undoes the action performed by <a href="#weaken">"weaken"</a>.</p> <p>This function is slightly neater and more convenient than the otherwise-equivalent code</p> <pre><code>my $tmp = $REF; undef $REF; $REF = $tmp;</code></pre> <p>(because in particular, simply assigning a weak reference back to itself does not work to unweaken it; <code>$REF = $REF</code> does not work).</p> <h2 id="isweak"><a class="permalink" href="#isweak">#</a>isweak</h2> <pre><code>my $weak = isweak( $ref );</code></pre> <p>Returns true if <code>$ref</code> is a weak reference.</p> <pre><code>$ref = \$foo; $weak = isweak($ref); # false weaken($ref); $weak = isweak($ref); # true</code></pre> <p><b>NOTE</b>: Copying a weak reference creates a normal, strong, reference.</p> <pre><code>$copy = $ref; $weak = isweak($copy); # false</code></pre> <h1 id="OTHER-FUNCTIONS"><a class="permalink" href="#OTHER-FUNCTIONS">#</a><a id="OTHER"></a>OTHER FUNCTIONS</h1> <h2 id="dualvar"><a class="permalink" href="#dualvar">#</a>dualvar</h2> <pre><code>my $var = dualvar( $num, $string );</code></pre> <p>Returns a scalar that has the value <code>$num</code> in a numeric context and the value <code>$string</code> in a string context.</p> <pre><code>$foo = dualvar 10, "Hello"; $num = $foo + 2; # 12 $str = $foo . " world"; # Hello world</code></pre> <h2 id="isdual"><a class="permalink" href="#isdual">#</a>isdual</h2> <pre><code>my $dual = isdual( $var );</code></pre> <p><i>Since version 1.26.</i></p> <p>If <code>$var</code> is a scalar that has both numeric and string values, the result is true.</p> <pre><code>$foo = dualvar 86, "Nix"; $dual = isdual($foo); # true</code></pre> <p>Note that a scalar can be made to have both string and numeric content through numeric operations:</p> <pre><code>$foo = "10"; $dual = isdual($foo); # false $bar = $foo + 0; $dual = isdual($foo); # true</code></pre> <p>Note that although <code>$!</code> appears to be dual-valued variable, it is actually implemented using a tied scalar:</p> <pre><code>$! = 1; print("$!\n"); # "Operation not permitted" $dual = isdual($!); # false</code></pre> <p>You can capture its numeric and string content using:</p> <pre><code>$err = dualvar $!, $!; $dual = isdual($err); # true</code></pre> <h2 id="isvstring"><a class="permalink" href="#isvstring">#</a>isvstring</h2> <pre><code>my $vstring = isvstring( $var );</code></pre> <p>If <code>$var</code> is a scalar which was coded as a vstring the result is true.</p> <pre><code>$vs = v49.46.48; $fmt = isvstring($vs) ? "%vd" : "%s"; #true printf($fmt,$vs);</code></pre> <h2 id="looks_like_number"><a class="permalink" href="#looks_like_number">#</a>looks_like_number</h2> <pre><code>my $isnum = looks_like_number( $var );</code></pre> <p>Returns true if perl thinks <code>$var</code> is a number. See <a href="/5.24.4/perlapi#looks_like_number">"looks_like_number" in perlapi</a>.</p> <h2 id="openhandle"><a class="permalink" href="#openhandle">#</a>openhandle</h2> <pre><code>my $fh = openhandle( $fh );</code></pre> <p>Returns <code>$fh</code> itself if <code>$fh</code> may be used as a filehandle and is open, or is is a tied handle. Otherwise <code>undef</code> is returned.</p> <pre><code>$fh = openhandle(*STDIN); # \*STDIN $fh = openhandle(\*STDIN); # \*STDIN $fh = openhandle(*NOTOPEN); # undef $fh = openhandle("scalar"); # undef</code></pre> <h2 id="readonly"><a class="permalink" href="#readonly">#</a>readonly</h2> <pre><code>my $ro = readonly( $var );</code></pre> <p>Returns true if <code>$var</code> is readonly.</p> <pre><code>sub foo { readonly($_[0]) } $readonly = foo($bar); # false $readonly = foo(0); # true</code></pre> <h2 id="set_prototype"><a class="permalink" href="#set_prototype">#</a>set_prototype</h2> <pre><code>my $code = set_prototype( $code, $prototype );</code></pre> <p>Sets the prototype of the function given by the <code>$code</code> reference, or deletes it if <code>$prototype</code> is <code>undef</code>. Returns the <code>$code</code> reference itself.</p> <pre><code>set_prototype \&foo, '$$';</code></pre> <h2 id="tainted"><a class="permalink" href="#tainted">#</a>tainted</h2> <pre><code>my $t = tainted( $var );</code></pre> <p>Return true if <code>$var</code> is tainted.</p> <pre><code>$taint = tainted("constant"); # false $taint = tainted($ENV{PWD}); # true if running under -T</code></pre> <h1 id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">#</a>DIAGNOSTICS</h1> <p>Module use may give one of the following errors during import.</p> <dl> <dt id="Weak-references-are-not-implemented-in-the-version-of-perl"><a class="permalink" href="#Weak-references-are-not-implemented-in-the-version-of-perl">#</a><a id="Weak"></a>Weak references are not implemented in the version of perl</dt> <dd> <p>The version of perl that you are using does not implement weak references, to use <a href="#isweak">"isweak"</a> or <a href="#weaken">"weaken"</a> you will need to use a newer release of perl.</p> </dd> <dt id="Vstrings-are-not-implemented-in-the-version-of-perl"><a class="permalink" href="#Vstrings-are-not-implemented-in-the-version-of-perl">#</a><a id="Vstrings"></a>Vstrings are not implemented in the version of perl</dt> <dd> <p>The version of perl that you are using does not implement Vstrings, to use <a href="#isvstring">"isvstring"</a> you will need to use a newer release of perl.</p> </dd> <dt id="NAME-is-only-available-with-the-XS-version-of-Scalar::Util"><a class="permalink" href="#NAME-is-only-available-with-the-XS-version-of-Scalar::Util">#</a><a id="NAME1"></a><code>NAME</code> is only available with the XS version of Scalar::Util</dt> <dd> <p><code>Scalar::Util</code> contains both perl and C implementations of many of its functions so that those without access to a C compiler may still use it. However some of the functions are only available when a C compiler was available to compile the XS version of the extension.</p> <p>At present that list is: weaken, isweak, dualvar, isvstring, set_prototype</p> </dd> </dl> <h1 id="KNOWN-BUGS"><a class="permalink" href="#KNOWN-BUGS">#</a><a id="KNOWN"></a>KNOWN BUGS</h1> <p>There is a bug in perl5.6.0 with UV's that are >= 1<<31. This will show up as tests 8 and 9 of dualvar.t failing</p> <h1 id="SEE-ALSO"><a class="permalink" href="#SEE-ALSO">#</a><a id="SEE"></a>SEE ALSO</h1> <p><a href="/5.24.4/List::Util">List::Util</a></p> <h1 id="COPYRIGHT"><a class="permalink" href="#COPYRIGHT">#</a>COPYRIGHT</h1> <p>Copyright (c) 1997-2007 Graham Barr <gbarr@pobox.com>. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.</p> <p>Additionally <a href="#weaken">"weaken"</a> and <a href="#isweak">"isweak"</a> which are</p> <p>Copyright (c) 1999 Tuomas J. Lukka <lukka@iki.fi>. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as perl itself.</p> <p>Copyright (C) 2004, 2008 Matthijs van Duin. All rights reserved. Copyright (C) 2014 cPanel Inc. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl 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

Scalar::Util - A selection of general-utility scalar subroutines - Perldoc Browser