File::Find::Object::Result - a result class for File::Find::Object

- NAME
- DESCRIPTION
- METHODS
  - File::Find::Object::Result->new({%args});
  - $result->base()
  - $result->path()
  - $result->is_dir()
  - $result->is_file()
  - $result->is_link()
  - $result->dir_components()
  - $result->basename()
  - $result->full_components()
  - $result->stat_ret()
- SEE ALSO
- LICENSE

# NAME

File::Find::Object::Result - a result class for File::Find::Object

# DESCRIPTION

This is a class returning a single File::Find::Object result as returned by its next_obj() method.

# METHODS

## File::Find::Object::Result->new({%args});

Initializes a new object from %args. For internal use.

## $result->base()

Returns the base directory from which searching began.

## $result->path()

Returns the full path of the result. As such `$ffo->next_obj()->path()` is equivalent to `$ffo->next()` .

## $result->is_dir()

Returns true if the result refers to a directory.

## $result->is_file()

Returns true if the result refers to a plain file (equivalent to the Perl `-f` operator).

## $result->is_link()

Returns true if the result is a symbolic link.

## $result->dir_components()

The components of the directory part of the path starting from base() (also the full path if the result is a directory) as an array reference.

## $result->basename()

Returns the basename of the file (if it is a file and not a directory.) Otherwise - undef().

## $result->full_components()

Returns the full components of the result with the basename if it is a file.

Returns a single array reference.

## $result->stat_ret()

The return value of "stat" in perlfunc for the result, placed inside an array reference. This is calculated by File::Find::Object and kept here for convenience and for internal use.

# SEE ALSO

File::Find::Object

# LICENSE

Copyright (C) 2005, 2006 by Olivier Thauvin

This package is free software; you can redistribute it and/or modify it under the following terms:

1. The GNU General Public License Version 2.0 - http://www.opensource.org/licenses/gpl-license.php

2. The Artistic License Version 2.0 - http://www.perlfoundation.org/legal/licenses/artistic-2_0.html

3. At your option - any later version of either or both of these licenses.

File::Find::Object::Result - a result class for File::Find::Object