NAME

File::ValueFile - module for reading and writing ValueFile files

VERSION

version v0.03

SYNOPSIS

use File::ValueFile;

This module only provides some global functionality.

For reading and writing ValueFiles see File::ValueFile::Simple::Reader and File::ValueFile::Simple::Writer.

METHODS

known

my @list = File::ValueFile->known($class [, %opts ] );

This method will return a list of well known tags of the given class $class.

Currently no specific classes is defined. The pseudo class :all is however supported.

Note: This method might soon be reimplemented to implement the interface defined by Data::Identifier::Interface::Known.

The following options are supported (all optional):

as

The type to be used to return tags in. Currently supported values are: uuid, oid, uri, ise, Data::Identifier.

Note: The default is not yet defined and may change in future versions of this module.

Note: All entries for the given class must support to be returned in the type given here.

default

The value to be returned when the given class is not supported. This must be an array reference. This can be set to [] to switching dieing off for unsupported classes.

add_utf8_marker

File::ValueFile->add_utf8_marker(format => $id);
# or:
File::ValueFile->add_utf8_marker(feature => $id);

Add a format or feature (given by $id) as a marker for UTF-8 en/decoding. Formats and features that have been marked to use UTF-8 are autodetected in File::ValueFile::Simple::Reader and File::ValueFile::Simple::Writer.

$id can be any value supported by "new" in Data::Identifier's from mode. However It is often wise to pass an instance of Data::Identifier which is already registered using "register" in Data::Identifier.

AUTHOR

Löwenfelsen UG (haftungsbeschränkt) <support@loewenfelsen.net>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2024 by Löwenfelsen UG (haftungsbeschränkt) <support@loewenfelsen.net>.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)