Provided by: libcode-tidyall-perl_0.18-1_all
NAME
Code::TidyAll::Result - Result returned from processing a file/source
VERSION
version 0.18
SYNOPSIS
my $ct = Code::TidyAll->new(...); my $result = $ct->process_file($file); if ($result->error) { ... }
DESCRIPTION
Represents the result of Code::TidyAll::process_file and Code::TidyAll::process_file. A list of these is returned from Code::TidyAll::process_paths.
METHODS
path The path that was processed, relative to the root (e.g. "lib/Foo.pm") state A string, one of "no_match" - No plugins matched this file "cached" - Cache hit (file had not changed since last processed) "error" - An error occurred while applying one of the plugins "checked" - File was successfully checked and did not change "tidied" - File was successfully checked and changed new_contents Contains the new contents if state is 'tidied' error Contains the error message if state is 'error' ok Returns true iff state is not 'error'
SEE ALSO
Code::TidyAll
AUTHOR
Jonathan Swartz <swartz@pobox.com>
COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by Jonathan Swartz. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.