dbm::deep::iterator::file::index(3pm) [debian man page]

DBM::Deep::Iterator::File::Index(3pm)			User Contributed Perl Documentation		     DBM::Deep::Iterator::File::Index(3pm)

NAME

       DBM::Deep::Iterator::Index - mediate between DBM::Deep::Iterator and DBM::Deep::Engine::Sector::Index

PURPOSE

       This is an internal-use-only object for DBM::Deep. It acts as the mediator between the DBM::Deep::Iterator object and a
       DBM::Deep::Engine::Sector::Index sector.

OVERVIEW

       This object, despite the implied class hiearchy, does NOT inherit from DBM::Deep::Iterator. Instead, it delegates to it, essentially acting
       as a facade over it. "get_next_key" in DBM::Deep::Iterator will instantiate one of these objects as needed to handle an Index sector.

METHODS

   new(\%params)
       The constructor takes a hashref of params and blesses it into the invoking class. The hashref is assumed to have the following elements:

       o   iterator (of type DBM::Deep::Iterator

       o   sector (of type DBM::Deep::Engine::Sector::Index

   at_end()
       This takes no arguments.

       This returns true/false indicating whether this sector has any more elements that can be iterated over.

   get_next_iterator()
       This takes no arguments.

       This returns an iterator (built by "get_sector_iterator" in DBM::Deep::Iterator) based on the sector pointed to by the next occupied
       location in this index.

       If the sector is exhausted, it returns nothing.

perl v5.14.2							    2012-06-24				     DBM::Deep::Iterator::File::Index(3pm)

DBM::Deep::Storage::File(3pm)				User Contributed Perl Documentation			     DBM::Deep::Storage::File(3pm)

NAME

       DBM::Deep::Storage::File - mediate low-level interaction with storage mechanism

PURPOSE

       This is an internal-use-only object for DBM::Deep. It mediates the low-level interaction with the storage mechanism.

       Currently, the only storage mechanism supported is the file system.

OVERVIEW

       This class provides an abstraction to the storage mechanism so that the Engine (the only class that uses this class) doesn't have to worry
       about that.

METHODS

   new( \%args )
   open()
       This method opens the filehandle for the filename in " file ".

       There is no return value.

   close()
       If the filehandle is opened, this will close it.

       There is no return value.

   size()
       This will return the size of the DB. If file_offset is set, this will take that into account.

       NOTE: This function isn't used internally anywhere.

   set_inode()
       This will set the inode value of the underlying file object.

       This is only needed to handle some obscure Win32 bugs. It reqlly shouldn't be needed outside this object.

       There is no return value.

   print_at( $offset, @data )
       This takes an optional offset and some data to print.

	$offset , if defined, will be used to seek into the file. If file_offset is set, it will be used as the zero location. If it is undefined,
       no seeking will occur. Then,  @data  will be printed to the current location.

       There is no return value.

   read_at( $offset, $length )
       This takes an optional offset and a length.

	$offset , if defined, will be used to seek into the file. If file_offset is set, it will be used as the zero location. If it is undefined,
       no seeking will occur. Then,  $length  bytes will be read from the current location.

       The data read will be returned.

   DESTROY
       When the ::Storage::File object goes out of scope, it will be closed.

   request_space( $size )
       This takes a size and adds that much space to the DBM.

       This returns the offset for the new location.

   copy_stats( $target_filename )
       This will take the stats for the current filehandle and apply them to  $target_filename . The stats copied are:

       o   Onwer UID and GID

       o   Permissions

perl v5.14.2							    2012-06-24					     DBM::Deep::Storage::File(3pm)