NAME
Declare::Constraints::Simple::Result - Validation Result
SYNOPSIS
my $result = $constraint->($value);
my $message = $result->message;
my $path = $result->path;
DESCRIPTION
This represents a result returned by a Declare::Constraints::Simple constraint. Objects of this kind overload their boolean context, so the value of the is_valid() accessor is reflected to it.
METHODS
new()
Constructor. As you will mostly just receive result objects, you should never be required to call this yourself.
set_valid($bool)
Sets the results validity flag.
is_valid()
Boolean accessor telling if this is a true result or not.
set_message($message)
The error message. Useful only on non-valid results.
message()
Returns the message of the result object.
add_to_stack($constraint_name)
This adds another level at the beginning (!) of the results constraint stack. This is mostly intended to use for the prepare_generator
method in Declare::Constraints::Simple::Library package.
path([$separator])
Returns a string containing the stack() contents joined together by the $separator
string (defaulting to .
).
stack()
Returns an array reference containing the results currrent stack. This is a list of the constraints path parts. This is usually just the constraints name. If there's additional info, it is appended to the name like [$info]
.
SEE ALSO
AUTHOR
Robert 'phaylon' Sedlacek <phaylon@dunkelheit.at>
LICENSE AND COPYRIGHT
This module is free software, you can redistribute it and/or modify it under the same terms as perl itself.