NAME

Filesys::Virtual::FFRIndexed - export an FFRIndexed database as file system

SYNOPSIS

  my $fs = Filesys::Virtual::FFRIndexed->new();

`$fs->new $ARGREF`

Instantiates a new filesystem instance.

The following keys in $ARGREF are recognized:

    root_path - a string that will be prepended/stripped before FFRIndexed is queried
                This should enable "mounting" the FFRIndexed tree/graph anywhere in
                an existing L<Filesys::Virtual> tree.
                
                This parameter currently gets ignored though.
    
    index     - a preinitialized L<FFRIndexed> instance. If this is not
                given, a fresh instance will be created.
                
    cwd       - current path
    
    columns   - the columns used for refinements

The remaining arguments are passed immediately through to the FFRIndexed instance.

`$fs->login`

Does nothing

`$fs->cwd`

Returns the current (query) path.

`$fs->root_path`

Returns the root_path, the root of this file system.

`$fs->chmod`

Unimplemented - the file system is readonly

`$fs->modtime $file`

Returns the time of last modification of $file

Currently implemented as a stub that always returns 0.

`$fs->size $file`

Returns the size in bytes of $file

Currently implemented as a stub that always returns 0.

`$fs->delete $file`

Unimplemented - the file system is readonly

`$fs->chdir $dir`

Refines the query.

`$fs->requery $directory`

Returns the cached $query object if $directory is equal to $cwd.

`$fs->get_query $directory`

Unconditionally retrieves the FFRIndexed object for a query path.

`$fs->folder_contents`

Returns a list of objects representing the current contents of the folder and additionally all subfolders.

`$fs->mkdir $dir`

Unimplemented - the file system is readonly

`$fs->rmdir $dir`

Unimplemented - the file system is readonly

`$fs->list $dir`

Returns the names of the contents of the directory as a (sorted) list.

If $dir actually is a file, its name is returned.

`$fs->list_details $dir`

Returns the names of the contents of the directory as a list in ls -l format (which is then, subsequently, unpacked again from the wrapping application ...).

`$fs->ls_stat $item`

Returns a string containing $item in ls -l format

`$fs->stat $file`

Returns the information as a stat call would

Currently implemented as a list of nine zeroes.

`$fs->test $test, $item`

Performs the file system test $test on $item