Data::Object::Library
Data-Object Type Library
use Data::Object::Library;
This package provides a core type library for the Do framework.
This package inherits behaviors from:
Type::Library
Types::Standard
Types::Common::String
Types::Common::Numeric
This package implements the following functions.
DoArgs() : HashRef
This function returns the type configuration for a Data::Object::Args object.
Data::Object::Library::DoArgs();
DoArray() : HashRef
This function returns the type configuration for a Data::Object::Array object.
Data::Object::Library::DoArray();
DoBoolean() : HashRef
This function returns the type configuration for a Data::OBject::Code object.
Data::Object::Library::DoBoolean();
DoCli() : HashRef
This function returns the type configuration for a Data::Object::Cli object.
Data::Object::Library::DoCli();
DoCode() : HashRef
This function returns the type configuration for a Data::Object::Code object.
Data::Object::Library::DoCode();
DoData() : HashRef
This function returns the type configuration for a Data::Object::Data object.
Data::Object::Library::DoData();
DoDumpable() : HashRef
This function returns the type configuration for an object with the Data::Object::Role::Dumpable role.
Data::Object::Library::DoDumpable();
DoException() : HashRef
This function returns the type configuration for a Data::Object::Exception object.
Data::Object::Library::DoException();
DoFloat() : HashRef
This function returns the type configuration for a Data::Object::Float object.
Data::Object::Library::DoFloat();
DoFunc() : HashRef
This function returns the type configuration for a Data::Object::Func object.
Data::Object::Library::DoFunc();
DoHash() : HashRef
This function returns the type configuration for a Data::Object::Hash object.
Data::Object::Library::DoHash();
DoImmutable() : HashRef
This function returns the type configuration for an object with the Data::Object::Role::Immutable role.
Data::Object::Library::DoImmutable();
DoNumber() : HashRef
This function returns the type configuration for a Data::Object::Number object.
Data::Object::Library::DoNumber();
DoOpts() : HashRef
This function returns the type configuration for a Data::Object::Opts object.
Data::Object::Library::DoOpts();
DoRegexp() : HashRef
This function returns the type configuration for a Data::Object::Regexp object.
Data::Object::Library::DoRegexp();
DoReplace() : HashRef
This function returns the type configuration for a Data::Object::Replace object.
Data::Object::Library::DoReplace();
DoScalar() : HashRef
This function returns the type configuration for a Data::Object::Scalar object.
Data::Object::Library::DoScalar();
DoSearch() : HashRef
This function returns the type configuration for a Data::Object::Search object.
Data::Object::Library::DoSearch();
DoSpace() : HashRef
This function returns the type configuration for a Data::Object::Space object.
Data::Object::Library::DoSpace();
DoStashable() : HashRef
This function returns the type configuration for an object with the Data::Object::Role::Stashable role.
Data::Object::Library::DoStashable();
DoState() : HashRef
This function returns the type configuration for a Data::Object::State object.
Data::Object::Library::DoState();
DoString() : HashRef
This function returns the type configuration for a Data::Object::String object.
Data::Object::Library::DoString();
DoStruct() : HashRef
This function returns the type configuration for a Data::Object::Struct object.
Data::Object::Library::DoStruct();
DoThrowable() : HashRef
This function returns the type configuration for an object with the Data::Object::Role::Throwable role.
Data::Object::Library::DoThrowable();
DoUndef() : HashRef
This function returns the type configuration for a Data::Object::Undef object.
Data::Object::Library::DoUndef();
DoVars() : HashRef
This function returns the type configuration for a Data::Object::Vars object.
Data::Object::Library::DoVars();
GenerateCoercion(HashRef $config) : InstanceOf["Type::Coercion"]
This function takes a type configuration hashref, then generates and returns a type coercion based on its configuration.
Data::Object::Library::GenerateCoercion({...});
GenerateConstraint(HashRef $config) : CodeRef
This function takes a type configuration hashref, then generates and returns a coderef which validates the type based on its configuration.
Data::Object::Library::GenerateConstraint({...});
GenerateExplanation(HashRef $config) : CodeRef
This function takes a type configuration hashref, then generates and returns a coderef which returns a deep-explanation of the type failure based on its configuration.
Data::Object::Library::GenerateExplanation({...});
Library() : InstanceOf["Type::Library"]
This function returns the core type library object.
Data::Object::Library::Library();
Options(HashRef $config) : (Any)
This function takes a type configuration hashref, then generates and returns a set of options relevant to creating Type::Tiny objects.
Data::Object::Library::Options({...});
Register(HashRef $config) : InstanceOf["Type::Tiny"]
This function takes a type configuration hashref, then generates and returns a Type::Tiny object based on its configuration.
Data::Object::Library::Register({...});
RegisterAll(HashRef $config) : InstanceOf["Type::Tiny"]
This function takes a type configuration hashref, then generates and returns a Type::Tiny object based on its configuration. This method also registers aliases as stand-alone types in the library.
Data::Object::Library::RegisterAll({...});
This package provides the following type constraints.
# Any
The Any type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_Any function can be used to throw an exception is the argument can not be validated. The is_Any function can be used to return true or false if the argument can not be validated.
Any
assert_Any
is_Any
# ArrayLike
The ArrayLike type constraint is provided by the Types::TypeTiny library. Please see that documentation for more information. The assert_ArrayLike function can be used to throw an exception if the argument can not be validated. The is_ArrayLike function can be used to return true or false if the argument can not be validated.
ArrayLike
assert_ArrayLike
is_ArrayLike
# ArgsObj
The ArgsObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Args object. The assert_ArgsObj function can be used to throw an exception if the argument can not be validated. The is_ArgsObj function can be used to return true or false if the argument can not be validated.
ArgsObj
assert_ArgsObj
is_ArgsObj
# ArgsObject
The ArgsObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Args object. The assert_ArgsObject function can be used to throw an exception if the argument can not be validated. The is_ArgsObject function can be used to return true or false if the argument can not be validated.
ArgsObject
assert_ArgsObject
is_ArgsObject
# ArrayObj
The ArrayObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Array object. The assert_ArrayObj function can be used to throw an exception if the argument can not be validated. The is_ArrayObj function can be used to return true or false if the argument can not be validated.
ArrayObj
assert_ArrayObj
is_ArrayObj
# ArrayObject
The ArrayObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Array object. The assert_ArrayObject function can be used to throw an exception if the argument can not be validated. The is_ArrayObject function can be used to return true or false if the argument can not be validated.
ArrayObject
assert_ArrayObject
is_ArrayObject
# ArrayRef
The ArrayRef type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_ArrayRef function can be used to throw an exception if the argument can not be validated. The is_ArrayRef function can be used to return true or false if the argument can not be validated.
ArrayRef
assert_ArrayRef
is_ArrayRef
# Bool
The Bool type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_Bool function can be used to throw an exception if the argument can not be validated. The is_Bool function can be used to return true or false if the argument can not be validated.
Bool
assert_Bool
is_Bool
# BoolObj
The BoolObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Boolean object. The assert_BoolObj function can be used to throw an exception if the argument can not be validated. The is_BoolObj function can be used to return true or false if the argument can not be validated.
BoolObj
assert_BoolObj
is_BoolObj
# BoolObject
The BoolObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Boolean object. The assert_BoolObject function can be used to throw an exception if the argument can not be validated. The is_BoolObject function can be used to return true or false if the argument can not be validated.
BoolObject
assert_BoolObject
is_BoolObject
# BooleanObj
The BooleanObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Boolean object. The assert_BooleanObj function can be used to throw an exception if the argument can not be validated. The is_BooleanObj function can be used to return true or false if the argument can not be validated.
BooleanObj
assert_BooleanObj
is_BooleanObj
# BooleanObject
The BooleanObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Boolean object. The assert_BooleanObject function can be used to throw an exception if the argument can not be validated. The is_BooleanObject function can be used to return true or false if the argument can not be validated.
BooleanObject
assert_BooleanObject
is_BooleanObject
# ClassName["MyClass"]
The ClassName type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_ClassName function can be used to throw an exception if the argument can not be validated. The is_ClassName function can be used to return true or false if the argument can not be validated.
ClassName
assert_ClassName
is_ClassName
# CodeLike
The CodeLike type constraint is provided by the Types::TypeTiny library. Please see that documentation for more information. The assert_CodeLike function can be used to throw an exception if the argument can not be validated. The is_CodeLike function can be used to return true or false if the argument can not be validated.
CodeLike
assert_CodeLike
is_CodeLike
# CliObj
The CliObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Cli object. The assert_CliObj function can be used to throw an exception if the argument can not be validated. The is_CliObj function can be used to return true or false if the argument can not be validated.
CliObj
assert_CliObj
is_CliObj
# CliObject
The CliObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Cli object. The assert_CliObject function can be used to throw an exception if the argument can not be validated. The is_CliObject function can be used to return true or false if the argument can not be validated.
CliObject
assert_CliObject
is_CliObject
# CodeObj
The CodeObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Code object. The assert_CodeObj function can be used to throw an exception if the argument can not be validated. The is_CodeObj function can be used to return true or false if the argument can not be validated.
CodeObj
assert_CodeObj
is_CodeObj
# CodeObject
The CodeObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Code object. The assert_CodeObject function can be used to throw an exception if the argument can not be validated. The is_CodeObject function can be used to return true or false if the argument can not be validated.
CodeObject
assert_CodeObject
is_CodeObject
# CodeRef
The CodeRef type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_CodeRef function can be used to throw an exception if the argument can not be validated. The is_CodeRef function can be used to return true or false if the argument can not be validated.
CodeRef
assert_CodeRef
is_CodeRef
# ConsumerOf["MyRole"]
The ConsumerOf type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_ConsumerOf function can be used to throw an exception if the argument can not be validated. The is_ConsumerOf function can be used to return true or false if the argument can not be validated.
ConsumerOf
assert_ConsumerOf
is_ConsumerOf
# DataObj
The DataObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Data object. The assert_DataObj function can be used to throw an exception if the argument can not be validated. The is_DataObj function can be used to return true or false if the argument can not be validated.
DataObj
assert_DataObj
is_DataObj
# DataObject
The DataObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Data object. The assert_DataObject function can be used to throw an exception if the argument can not be validated. The is_DataObject function can be used to return true or false if the argument can not be validated.
DataObject
assert_DataObject
is_DataObject
# Defined
The Defined type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_Defined function can be used to throw an exception if the argument can not be validated. The is_Defined function can be used to return true or false if the argument can not be validated.
Defined
assert_Defined
is_Defined
# Dict
The Dict type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_Dict function can be used to throw an exception if the argument can not be validated. The is_Dict function can be used to return true or false if the argument can not be validated.
Dict
assert_Dict
is_Dict
# Dumpable
The Dumpable type constraint is provided by this library and accepts any object that is a consumer of the Data::Object::Role::Dumpable role. The assert_Dumpable function can be used to throw an exception if the argument can not be validated. The is_Dumpable function can be used to return true or false if the argument can not be validated.
Dumpable
assert_Dumpable
is_Dumpable
# Enum[qw(A B C)]
The Enum type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_Enum function can be used to throw an exception if the argument can not be validated. The is_Enum function can be used to return true or false if the argument can not be validated.
Enum
assert_Enum
is_Enum
# ExceptionObj
The ExceptionObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Exception object. The assert_ExceptionObj function can be used to throw an exception if the argument can not be validated. The is_ExceptionObj function can be used to return true or false if the argument can not be validated.
ExceptionObj
assert_ExceptionObj
is_ExceptionObj
# ExceptionObject
The ExceptionObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Exception object. The assert_ExceptionObject function can be used to throw an exception if the argument can not be validated. The is_ExceptionObject function can be used to return true or false if the argument can not be validated.
ExceptionObject
assert_ExceptionObject
is_ExceptionObject
# FileHandle
The FileHandle type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_FileHandle function can be used to throw an exception if the argument can not be validated. The is_FileHandle function can be used to return true or false if the argument can not be validated.
FileHandle
assert_FileHandle
is_FileHandle
# FloatObj
The FloatObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Float object. The assert_FloatObj function can be used to throw an exception if the argument can not be validated. The is_FloatObj function can be used to return true or false if the argument can not be validated.
FloatObj
assert_FloatObj
is_FloatObj
# FloatObject
The FloatObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Float object. The assert_FloatObject function can be used to throw an exception if the argument can not be validated. The is_FloatObject function can be used to return true or false if the argument can not be validated.
FloatObject
assert_FloatObject
is_FloatObject
# FuncObj
The FuncObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Func object. The assert_FuncObj function can be used to throw an exception if the argument can not be validated. The is_FuncObj function can be used to return true or false if the argument can not be validated.
FuncObj
assert_FuncObj
is_FuncObj
# FuncObject
The FuncObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Func object. The assert_FuncObject function can be used to throw an exception if the argument can not be validated. The is_FuncObject function can be used to return true or false if the argument can not be validated.
FuncObject
assert_FuncObject
is_FuncObject
# GlobRef
The GlobRef type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_GlobRef function can be used to throw an exception if the argument can not be validated. The is_GlobRef function can be used to return true or false if the argument can not be validated.
GlobRef
assert_GlobRef
is_GlobRef
# HasMethods["new"]
The HasMethods type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_HasMethods function can be used to throw an exception if the argument can not be validated. The is_HasMethods function can be used to return true or false if the argument can not be validated.
HasMethods
assert_HasMethods
is_HasMethods
# HashLike
The HashLike type constraint is provided by the Types::TypeTiny library. Please see that documentation for more information. The assert_HashLike function can be used to throw an exception if the argument can not be validated. The is_HashLike function can be used to return true or false if the argument can not be validated.
HashLike
assert_HashLike
is_HashLike
# HashObj
The HashObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Hash object. The assert_HashObj function can be used to throw an exception if the argument can not be validated. The is_HashObj function can be used to return true or false if the argument can not be validated.
HashObj
assert_HashObj
is_HashObj
# HashObject
The HashObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Hash object. The assert_HashObject function can be used to throw an exception if the argument can not be validated. The is_HashObject function can be used to return true or false if the argument can not be validated.
HashObject
assert_HashObject
is_HashObject
# HashRef
The HashRef type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_HashRef function can be used to throw an exception if the argument can not be validated. The is_HashRef function can be used to return true or false if the argument can not be validated.
HashRef
assert_HashRef
is_HashRef
# Immutable
The Immutable type constraint is provided by this library and accepts any object that is a consumer of the Data::Object::Role::Immutable role. The assert_Immutable function can be used to throw an exception if the argument can not be validated. The is_Immutable function can be used to return true or false if the argument can not be validated.
Immutable
assert_Immutable
is_Immutable
# InstanceOf[MyClass]
The InstanceOf type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_InstanceOf function can be used to throw an exception if the argument can not be validated. The is_InstanceOf function can be used to return true or false if the argument can not be validated.
InstanceOf
assert_InstanceOf
is_InstanceOf
# Int
The Int type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_Int function can be used to throw an exception if the argument can not be validated. The is_Int function can be used to return true or false if the argument can not be validated.
Int
assert_Int
is_Int
# IntObj
The IntObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Integer object. The assert_IntObj function can be used to throw an exception if the argument can not be validated. The is_IntObj function can be used to return true or false if the argument can not be validated.
IntObj
assert_IntObj
is_IntObj
# IntObject
The IntObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Integer object. The assert_IntObject function can be used to throw an exception if the argument can not be validated. The is_IntObject function can be used to return true or false if the argument can not be validated.
IntObject
assert_IntObject
is_IntObject
# IntRange[0, 25]
The IntRange type constraint is provided by the Types::TypeTiny library. Please see that documentation for more information. The assert_IntRange function can be used to throw an exception if the argument can not be validated. The is_IntRange function can be used to return true or false if the argument can not be validated.
IntRange
assert_IntRange
is_IntRange
# IntegerObj
The IntegerObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Integer object. The assert_IntegerObj function can be used to throw an exception if the argument can not be validated. The is_IntegerObj function can be used to return true or false if the argument can not be validated.
IntegerObj
assert_IntegerObj
is_IntegerObj
# IntegerObject
The IntegerObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Integer object. The assert_IntegerObject function can be used to throw an exception if the argument can not be validated. The is_IntegerObject function can be used to return true or false if the argument can not be validated.
IntegerObject
assert_IntegerObject
is_IntegerObject
# Item
The Item type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_Item function can be used to throw an exception if the argument can not be validated. The is_Item function can be used to return true or false if the argument can not be validated.
Item
assert_Item
is_Item
# LaxNum
The LaxNum type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_LaxNum function can be used to throw an exception if the argument can not be validated. The is_LaxNum function can be used to return true or false if the argument can not be validated.
LaxNum
assert_LaxNum
is_LaxNum
# LowerCaseSimpleStr
The LowerCaseSimpleStr type constraint is provided by the Types::Common::String library. Please see that documentation for more The assert_LowerCaseSimpleStr function can be used to throw an exception if the argument can not be validated. The is_LowerCaseSimpleStr function can be used to return true or false if the argument can not be validated. information.
LowerCaseSimpleStr
assert_LowerCaseSimpleStr
is_LowerCaseSimpleStr
# LowerCaseStr
The LowerCaseStr type constraint is provided by the Types::Common::String library. Please see that documentation for more information. The assert_type function can be used to throw an exception if the argument can not be validated. The is_type function can be used to return true or false if the argument can not be validated.
LowerCaseStr
assert_type
is_type
# Map[Int, HashRef]
The Map type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_Map function can be used to throw an exception if the argument can not be validated. The is_Map function can be used to return true or false if the argument can not be validated.
Map
assert_Map
is_Map
# Maybe[Object]
The Maybe type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_Maybe function can be used to throw an exception if the argument can not be validated. The is_Maybe function can be used to return true or false if the argument can not be validated.
Maybe
assert_Maybe
is_Maybe
# NegativeInt
The NegativeInt type constraint is provided by the Types::Common::Numeric library. Please see that documentation for more information. The assert_NegativeInt function can be used to throw an exception if the argument can not be validated. The is_NegativeInt function can be used to return true or false if the argument can not be validated.
NegativeInt
assert_NegativeInt
is_NegativeInt
# NegativeNum
The NegativeNum type constraint is provided by the Types::Common::Numeric library. Please see that documentation for more information. The assert_NegativeNum function can be used to throw an exception if the argument can not be validated. The is_NegativeNum function can be used to return true or false if the argument can not be validated.
NegativeNum
assert_NegativeNum
is_NegativeNum
# NegativeOrZeroInt
The NegativeOrZeroInt type constraint is provided by the Types::Common::Numeric library. Please see that documentation for more The assert_NegativeOrZeroInt function can be used to throw an exception if the argument can not be validated. The is_NegativeOrZeroInt function can be used to return true or false if the argument can not be validated. information.
NegativeOrZeroInt
assert_NegativeOrZeroInt
is_NegativeOrZeroInt
# NegativeOrZeroNum
The NegativeOrZeroNum type constraint is provided by the Types::Common::Numeric library. Please see that documentation for more The assert_type function can be used to throw an exception if the argument can not be validated. The is_type function can be used to return true or false if the argument can not be validated. information.
NegativeOrZeroNum
# NonEmptySimpleStr
The NonEmptySimpleStr type constraint is provided by the Types::Common::String library. Please see that documentation for more The assert_type function can be used to throw an exception if the argument can not be validated. The is_type function can be used to return true or false if the argument can not be validated. information.
NonEmptySimpleStr
# NonEmptyStr
The NonEmptyStr type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_type function can be used to throw an exception if the argument can not be validated. The is_type function can be used to return true or false if the argument can not be validated.
NonEmptyStr
# Num
The Num type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_Num function can be used to throw an exception if the argument can not be validated. The is_Num function can be used to return true or false if the argument can not be validated.
Num
assert_Num
is_Num
# NumberLike
The NumberLike type constraint is provided by the this library and accepts any value that looks like a number, or object that overloads stringification and looks like a number stringified. Please see that documentation for more information. The assert_NumberLike function can be used to throw an exception if the argument can not be validated. The is_NumberLike function can be used to return true or false if the argument can not be validated.
NumberLike
assert_NumberLike
is_NumberLike
# NumObj
The NumObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Number object. The assert_NumObj function can be used to throw an exception if the argument can not be validated. The is_NumObj function can be used to return true or false if the argument can not be validated.
NumObj
assert_NumObj
is_NumObj
# NumObject
The NumObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Number object. The assert_NumObject function can be used to throw an exception if the argument can not be validated. The is_NumObject function can be used to return true or false if the argument can not be validated.
NumObject
assert_NumObject
is_NumObject
# NumRange[0, 25]
The NumRange type constraint is provided by the Types::TypeTiny library. Please see that documentation for more information. The assert_NumRange function can be used to throw an exception if the argument can not be validated. The is_NumRange function can be used to return true or false if the argument can not be validated.
NumRange
assert_NumRange
is_NumRange
# NumberObject
The NumberObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Number object. The assert_NumberObject function can be used to throw an exception if the argument can not be validated. The is_NumberObject function can be used to return true or false if the argument can not be validated.
NumberObject
assert_NumberObject
is_NumberObject
# NumericCode
The NumericCode type constraint is provided by the Types::Common::String library. Please see that documentation for more information. The assert_NumericCode function can be used to throw an exception if the argument can not be validated. The is_NumericCode function can be used to return true or false if the argument can not be validated.
NumericCode
assert_NumericCode
is_NumericCode
# Object
The Object type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_Object function can be used to throw an exception if the argument can not be validated. The is_Object function can be used to return true or false if the argument can not be validated.
Object
assert_Object
is_Object
# OptsObj
The OptsObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Opts object. The assert_OptsObj function can be used to throw an exception if the argument can not be validated. The is_OptsObj function can be used to return true or false if the argument can not be validated.
OptsObj
assert_OptsObj
is_OptsObj
# OptsObject
The OptsObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Opts object. The assert_OptsObject function can be used to throw an exception if the argument can not be validated. The is_OptsObject function can be used to return true or false if the argument can not be validated.
OptsObject
assert_OptsObject
is_OptsObject
# OptList
The OptList type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_OptList function can be used to throw an exception if the argument can not be validated. The is_OptList function can be used to return true or false if the argument can not be validated.
OptList
assert_OptList
is_OptList
# Dict[id => Optional[Int]]
The Optional type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_Optional function can be used to throw an exception if the argument can not be validated. The is_Optional function can be used to return true or false if the argument can not be validated.
Optional
assert_Optional
is_Optional
# Overload[qw("")]
The Overload type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_Overload function can be used to throw an exception if the argument can not be validated. The is_Overload function can be used to return true or false if the argument can not be validated.
Overload
assert_Overload
is_Overload
# Password
The Password type constraint is provided by the Types::Common::String library. Please see that documentation for more information. The assert_Password function can be used to throw an exception if the argument can not be validated. The is_Password function can be used to return true or false if the argument can not be validated.
Password
assert_Password
is_Password
# PositiveInt
The PositiveInt type constraint is provided by the Types::Common::Numeric library. Please see that documentation for more information. The assert_PositiveInt function can be used to throw an exception if the argument can not be validated. The is_PositiveInt function can be used to return true or false if the argument can not be validated.
PositiveInt
assert_PositiveInt
is_PositiveInt
# PositiveNum
The PositiveNum type constraint is provided by the Types::Common::Numeric library. Please see that documentation for more information. The assert_PositiveNum function can be used to throw an exception if the argument can not be validated. The is_PositiveNum function can be used to return true or false if the argument can not be validated.
PositiveNum
assert_PositiveNum
is_PositiveNum
# PositiveOrZeroInt
The PositiveOrZeroInt type constraint is provided by the Types::Common::Numeric library. Please see that documentation for more The assert_PositiveOrZeroInt function can be used to throw an exception if the argument can not be validated. The is_PositiveOrZeroInt function can be used to return true or false if the argument can not be validated. information.
PositiveOrZeroInt
assert_PositiveOrZeroInt
is_PositiveOrZeroInt
# PositiveOrZeroNum
The PositiveOrZeroNum type constraint is provided by the Types::Common::Numeric library. Please see that documentation for more The assert_type function can be used to throw an exception if the argument can not be validated. The is_type function can be used to return true or false if the argument can not be validated. information.
PositiveOrZeroNum
# Ref["SCALAR"]
The Ref type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_type function can be used to throw an exception if the argument can not be validated. The is_type function can be used to return true or false if the argument can not be validated.
Ref
# RegexpObj
The RegexpObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Regexp object. The assert_RegexpObj function can be used to throw an exception if the argument can not be validated. The is_RegexpObj function can be used to return true or false if the argument can not be validated.
RegexpObj
assert_RegexpObj
is_RegexpObj
# RegexpObject
The RegexpObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Regexp object. The assert_RegexpObject function can be used to throw an exception if the argument can not be validated. The is_RegexpObject function can be used to return true or false if the argument can not be validated.
RegexpObject
assert_RegexpObject
is_RegexpObject
# RegexpRef
The RegexpRef type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_RegexpRef function can be used to throw an exception if the argument can not be validated. The is_RegexpRef function can be used to return true or false if the argument can not be validated.
RegexpRef
assert_RegexpRef
is_RegexpRef
# ReplaceObj
The ReplaceObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Replace object. The assert_ReplaceObj function can be used to throw an exception if the argument can not be validated. The is_ReplaceObj function can be used to return true or false if the argument can not be validated.
ReplaceObj
assert_ReplaceObj
is_ReplaceObj
# ReplaceObject
The ReplaceObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Replace object. The assert_ReplaceObject function can be used to throw an exception if the argument can not be validated. The is_ReplaceObject function can be used to return true or false if the argument can not be validated.
ReplaceObject
assert_ReplaceObject
is_ReplaceObject
# RoleName
The RoleName type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_RoleName function can be used to throw an exception if the argument can not be validated. The is_RoleName function can be used to return true or false if the argument can not be validated.
RoleName
assert_RoleName
is_RoleName
# ScalarObj
The ScalarObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Scalar object. The assert_ScalarObj function can be used to throw an exception if the argument can not be validated. The is_ScalarObj function can be used to return true or false if the argument can not be validated.
ScalarObj
assert_ScalarObj
is_ScalarObj
# ScalarObject
The ScalarObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Scalar object. The assert_ScalarObject function can be used to throw an exception if the argument can not be validated. The is_ScalarObject function can be used to return true or false if the argument can not be validated.
ScalarObject
assert_ScalarObject
is_ScalarObject
# ScalarRef
The ScalarRef type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_ScalarRef function can be used to throw an exception if the argument can not be validated. The is_ScalarRef function can be used to return true or false if the argument can not be validated.
ScalarRef
assert_ScalarRef
is_ScalarRef
# SearchObj
The SearchObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Search object. The assert_SearchObj function can be used to throw an exception if the argument can not be validated. The is_SearchObj function can be used to return true or false if the argument can not be validated.
SearchObj
assert_SearchObj
is_SearchObj
# SearchObject
The SearchObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Search object. The assert_SearchObject function can be used to throw an exception if the argument can not be validated. The is_SearchObject function can be used to return true or false if the argument can not be validated.
SearchObject
assert_SearchObject
is_SearchObject
# SimpleStr
The SimpleStr type constraint is provided by the Types::Common::String library. Please see that documentation for more information. The assert_SimpleStr function can be used to throw an exception if the argument can not be validated. The is_SimpleStr function can be used to return true or false if the argument can not be validated.
SimpleStr
assert_SimpleStr
is_SimpleStr
# SingleDigit
The SingleDigit type constraint is provided by the Types::Common::Numeric library. Please see that documentation for more information. The assert_SingleDigit function can be used to throw an exception if the argument can not be validated. The is_SingleDigit function can be used to return true or false if the argument can not be validated.
SingleDigit
assert_SingleDigit
is_SingleDigit
# SpaceObj
The SpaceObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Space object. The assert_SpaceObj function can be used to throw an exception if the argument can not be validated. The is_SpaceObj function can be used to return true or false if the argument can not be validated.
SpaceObj
assert_SpaceObj
is_SpaceObj
# SpaceObject
The SpaceObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Space object. The assert_SpaceObject function can be used to throw an exception if the argument can not be validated. The is_SpaceObject function can be used to return true or false if the argument can not be validated.
SpaceObject
assert_SpaceObject
is_SpaceObject
# Stashable
The Stashable type constraint is provided by this library and accepts any object that is a consumer of the Data::Object::Role::Stashable role. The assert_Stashable function can be used to throw an exception if the argument can not be validated. The is_Stashable function can be used to return true or false if the argument can not be validated.
Stashable
assert_Stashable
is_Stashable
# StateObj
The StateObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::State object. The assert_StateObj function can be used to throw an exception if the argument can not be validated. The is_StateObj function can be used to return true or false if the argument can not be validated.
StateObj
assert_StateObj
is_StateObj
# StateObject
The StateObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::State object. The assert_StateObject function can be used to throw an exception if the argument can not be validated. The is_StateObject function can be used to return true or false if the argument can not be validated.
StateObject
assert_StateObject
is_StateObject
# Str
The Str type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_Str function can be used to throw an exception if the argument can not be validated. The is_Str function can be used to return true or false if the argument can not be validated.
Str
assert_Str
is_Str
# StrMatch[qr/^[A-Z]+$/]
The StrMatch type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_StrMatch function can be used to throw an exception if the argument can not be validated. The is_StrMatch function can be used to return true or false if the argument can not be validated.
StrMatch
assert_StrMatch
is_StrMatch
# StrObj
The StrObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::String object. The assert_StrObj function can be used to throw an exception if the argument can not be validated. The is_StrObj function can be used to return true or false if the argument can not be validated.
StrObj
assert_StrObj
is_StrObj
# StrObject
The StrObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::String object. The assert_StrObject function can be used to throw an exception if the argument can not be validated. The is_StrObject function can be used to return true or false if the argument can not be validated.
StrObject
assert_StrObject
is_StrObject
# StrictNum
The StrictNum type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_StrictNum function can be used to throw an exception if the argument can not be validated. The is_StrictNum function can be used to return true or false if the argument can not be validated.
StrictNum
assert_StrictNum
is_StrictNum
# StringLike
The StringLike type constraint is provided by the Types::TypeTiny library. Please see that documentation for more information. The assert_StringLike function can be used to throw an exception if the argument can not be validated. The is_StringLike function can be used to return true or false if the argument can not be validated.
StringLike
assert_StringLike
is_StringLike
# StringObj
The StringObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::String object. The assert_StringObj function can be used to throw an exception if the argument can not be validated. The is_StringObj function can be used to return true or false if the argument can not be validated.
StringObj
assert_StringObj
is_StringObj
# StringObject
The StringObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::String object. The assert_StringObject function can be used to throw an exception if the argument can not be validated. The is_StringObject function can be used to return true or false if the argument can not be validated.
StringObject
assert_StringObject
is_StringObject
# StrongPassword
The StrongPassword type constraint is provided by the Types::Common::String library. Please see that documentation for more information. The assert_StrongPassword function can be used to throw an exception if the argument can not be validated. The is_StrongPassword function can be used to return true or false if the argument can not be validated.
StrongPassword
assert_StrongPassword
is_StrongPassword
# StructObj
The StructObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Struct object. The assert_StructObj function can be used to throw an exception if the argument can not be validated. The is_StructObj function can be used to return true or false if the argument can not be validated.
StructObj
assert_StructObj
is_StructObj
# StructObject
The StructObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Struct object. The assert_StructObject function can be used to throw an exception if the argument can not be validated. The is_StructObject function can be used to return true or false if the argument can not be validated.
StructObject
assert_StructObject
is_StructObject
# Throwable
The Throwable type constraint is provided by this library and accepts any object that is a consumer of the Data::Object::Role::Throwable role. The assert_Throwable function can be used to throw an exception if the argument can not be validated. The is_Throwable function can be used to return true or false if the argument can not be validated.
Throwable
assert_Throwable
is_Throwable
# Tied["MyClass"]
The Tied type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_Tied function can be used to throw an exception if the argument can not be validated. The is_Tied function can be used to return true or false if the argument can not be validated.
Tied
assert_Tied
is_Tied
# Tuple[Int, Str, Str]
The Tuple type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_Tuple function can be used to throw an exception if the argument can not be validated. The is_Tuple function can be used to return true or false if the argument can not be validated.
Tuple
assert_Tuple
is_Tuple
# TypeTiny
The TypeTiny type constraint is provided by the Types::TypeTiny library. Please see that documentation for more information. The assert_TypeTiny function can be used to throw an exception if the argument can not be validated. The is_TypeTiny function can be used to return true or false if the argument can not be validated.
TypeTiny
assert_TypeTiny
is_TypeTiny
# Undef
The Undef type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_Undef function can be used to throw an exception if the argument can not be validated. The is_Undef function can be used to return true or false if the argument can not be validated.
Undef
assert_Undef
is_Undef
# UndefObj
The UndefObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Undef object. The assert_UndefObj function can be used to throw an exception if the argument can not be validated. The is_UndefObj function can be used to return true or false if the argument can not be validated.
UndefObj
assert_UndefObj
is_UndefObj
# UndefObject
The UndefObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Undef object. The assert_UndefObject function can be used to throw an exception if the argument can not be validated. The is_UndefObject function can be used to return true or false if the argument can not be validated.
UndefObject
assert_UndefObject
is_UndefObject
# UpperCaseSimpleStr
The UpperCaseSimpleStr type constraint is provided by the Types::Common::String library. Please see that documentation for more The assert_UpperCaseSimpleStr function can be used to throw an exception if the argument can not be validated. The is_UpperCaseSimpleStr function can be used to return true or false if the argument can not be validated. information.
UpperCaseSimpleStr
assert_UpperCaseSimpleStr
is_UpperCaseSimpleStr
# UpperCaseStr
The UpperCaseStr type constraint is provided by the Types::Common::String library. Please see that documentation for more information. The assert_UpperCaseStr function can be used to throw an exception if the argument can not be validated. The is_UpperCaseStr function can be used to return true or false if the argument can not be validated.
UpperCaseStr
assert_UpperCaseStr
is_UpperCaseStr
# Value
The Value type constraint is provided by the Types::Standard library. Please see that documentation for more information. The assert_Value function can be used to throw an exception if the argument can not be validated. The is_Value function can be used to return true or false if the argument can not be validated.
Value
assert_Value
is_Value
# VarsObj
The VarsObj type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Vars object. The assert_VarsObj function can be used to throw an exception if the argument can not be validated. The is_VarsObj function can be used to return true or false if the argument can not be validated.
VarsObj
assert_VarsObj
is_VarsObj
# VarsObject
The VarsObject type constraint is provided by this library and accepts any object that is, or is derived from, a Data::Object::Vars object. The assert_VarsObject function can be used to throw an exception if the argument can not be validated. The is_VarsObject function can be used to return true or false if the argument can not be validated.
VarsObject
assert_VarsObject
is_VarsObject
Al Newkirk, +319
+319
Anthony Brummett, +10
+10
Adam Hopkins, +2
+2
José Joaquín Atria, +1
+1
Al Newkirk, awncorp@cpan.org
awncorp@cpan.org
Copyright (C) 2011-2019, Al Newkirk, et al.
This is free software; you can redistribute it and/or modify it under the terms of the The Apache License, Version 2.0, as elucidated here, https://github.com/iamalnewkirk/do/blob/master/LICENSE.
Wiki
Project
Initiatives
Milestones
Contributing
Issues
To get the most out of this distribution, consider reading the following:
Do
Data::Object
Data::Object::Class
Data::Object::ClassHas
Data::Object::Role
Data::Object::RoleHas
To install Do, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Do
CPAN shell
perl -MCPAN -e shell install Do
For more information on module installation, please visit the detailed CPAN module installation guide.