#NAME

Types::Standard::ScalarRef - exporter utility for the ScalarRef type constraint

#SYNOPSIS

use Types::Standard -types;

# Normal way to validate a reference to a string.
#
ScalarRef->of( Str )->assert_valid( \ "foo" );

use Types::Standard::ScalarRef StrRef => { of => Str },

# Exported shortcut
#
assert_StrRef \ "foo";

#STATUS

This module is not covered by the Type-Tiny stability policy.

#DESCRIPTION

This is mostly internal code, but can also act as an exporter utility.

#Exports

Types::Standard::ScalarRef can be used experimentally as an exporter.

use Types::Standard 'Str';
use Types::Standard::ScalarRef StrRef => { of => Str };

This will export the following functions into your namespace:

#StrRef
#is_StrRef( $value )
#assert_StrRef( $value )
#to_StrRef( $value )

Multiple types can be exported at once:

use Types::Standard -types;
use Types::Standard::ScalarRef (
  IntRef  => { of => Int },
  StrRef  => { of => Str },
);

assert_IntRef \42;   # should not die

It's possible to further constrain the reference using where:

use Types::Standard::ScalarRef MyThing => { of => Str, where => sub { ... } };

#BUGS

Please report any bugs to https://github.com/tobyink/p5-type-tiny/issues.

#SEE ALSO

Types::Standard.

#AUTHOR

Toby Inkster <tobyink@cpan.org>.

#COPYRIGHT AND LICENCE

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

#DISCLAIMER OF WARRANTIES

THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

CONTENTS