##========================================================================
## POD DOCUMENTATION, auto-generated by podextract.perl

=pod

=cut

##========================================================================
## NAME
=pod

=head1 NAME

Tie::File::Indexed::Storable - tied array access to indexed data files: Storable-encoded references (native byte-order)

=cut

##========================================================================
## SYNOPSIS
=pod

=head1 SYNOPSIS

 use Tie::File::Indexed::Storable;
 tie(my @data, 'Tie::File::Indexed::Storable', $filename, %options) or die ...
 
 ##-- add some data
 $data[0] = {foo=>'bar'}; # transparently encode/decode perl hashes
 $data[1] = [1..10];      # ... or arrays
 $data[2] = \42;          # ... or scalar-refs
 $data[3] = undef;        # ... or undef
 print $data[1];          # retrieve & print a stored value

=cut

##========================================================================
## DESCRIPTION
=pod

=head1 DESCRIPTION

Tie::File::Indexed::Storable provides a
L<Tie::File::Indexed|Tie::File::Indexed> subclass for
storing arrays of perl data structures encoded using the Storable module.
Data items are written in the native byte-order using
L<Storable::store_fd()|Storable/"store_fd">.

See L<Tie::File::Indexed/"SUBCLASSES"> for an overview of the built-in
L<Tie::File::Indexed|Tie::File::Indexed> subclasses.

=cut

##========================================================================
## END POD DOCUMENTATION, auto-generated by podextract.perl

=pod

=cut

##========================================================================
## CAVEATS
=pod

=head1 CAVEATS

=head2 General caveats

See L<Tie::File::Indexed/CAVEATS> for general issues regarding the Tie::File::Indexed
base class.

=head2 In-place item modification not supported

See L<Tie::File::Indexed::JSON/"In-place item modification not supported"> for details.

=head2 Limited datatype support

Only references which can be successfully encoded and decoded by the L<Storable|Storable>
module are supported by this class. In particlar, that means that you can't store
raw SCALARs or CODE refs without further ado, although you B<CAN> store C<undef> values,
which Storable also doesn't support.
The Storable module itself provides additional hooks for serialization of
bless()ed object, see L<Storable> for details.

=cut

##======================================================================
## Footer
##======================================================================
=pod

=head1 AUTHOR

Bryan Jurish E<lt>moocow@cpan.orgE<gt>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2015 by Bryan Jurish

This package is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.20.2 or,
at your option, any later version of Perl 5 you may have available.

=cut