NAME

Brick::Result - the result of applying a profile

SYNOPSIS

        use Brick;

        my $result = $brick->apply( $Profile, $Input );

        $result->explain;

DESCRIPTION

This class provides methods to turn the data structure returned by apply() into a useable form for particular situations.

Class methods

result_item_class

Loads and returns the class name to use for the elements of the Results data structure.

Instance methods

explain

Create a string the shows the result in an outline form.

flatten

Collapse the result structure to an array of flat hashes.

flatten_by_field

Similar to flatten, but keyed by the field that failed the constraint.

flatten_by

Similar to flatten, but keyed by the hash key named in the argument list.

dump

What should this do?

TO DO

TBA

SEE ALSO

Brick::Tutorial, Brick::UserGuide

SOURCE AVAILABILITY

This source is in Github:

        https://github.com/briandfoy/brick

AUTHOR

brian d foy, <bdfoy@cpan.org>

COPYRIGHT

Copyright © 2007-2018, brian d foy <bdfoy@cpan.org>. All rights reserved.

You may redistribute this under the terms of the Artistic License 2.0.