/ 
Data-Filesystem-0.02
/ Data::Filesystem::Options

NAME

Data::Filesystem::Options - Data::Filesystem options

VERSION

version 0.02

SYNOPSIS

# getting option
if ($dfs->options->ro) { ... }

# setting option
$dfs->options->ro(1);

DESCRIPTION

Options for Data::Filesystem.

ATTRIBUTES

curdir_name => STR

Default is '.'.

See also: parentdir_name, path_separator.

parentdir_name => STR

Default is '..'.

See also: curdir_name, path_separator.

parse_volume => BOOL

Default is 1.

Volume is used to allow accessing several data structures. When parse_volume is set to true (which is the default), volume is parsed, e.g.:

foo:/a/b/c
bar:/a/b/c

They will be parsed, consecutively, as /a/b/c for the foo volume and /a/b/c for the bar volume.

But when parse_volume is turned off, they will be parsed in Unix-like style of single root tree, and thus you can't refer to volumes other than the active volume (but you can still use cvol() to change active volume).

See also: volume_separator.

path_separator => STR

Default is '/'. Note that since there is no escaping mechanism in path names, a path cannot contain the path separator name (as well as the curdir_name and parentdir_name). This is just like in Unix filesystem where you cannot have a filename with "/" in it, or a file/dir named "." and "..".

See also: curdir_name, parentdir_name, volume_separator.

ro => BOOL

Whether the filesystem should be read only. The default is 0, which means read/write.

When 'ro' is set to true, commands like unlink() and create_file() will fail. But note that since get() can retrieve reference to whole branches of data structure, you can always modify the data directly.

volume_separator => STR

Default is ':'. The string used to separate volume and path. This is only relevant when parse_volume in true.

See also: curdir_name, parentdir_name, parse_volume, path_separator.

new_hash_sub => VAL

Default is a sub to create {}. When creating a directory, this sub will be called. You can set this to generate a tied hash, e.g. when wanting to create a hash with case-insensitive keys (see Hash::Case).

AUTHOR

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2010 by Steven Haryanto.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.