framework/main/interfaces/io/pointer/io/class_InputOutputPointer.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Filesystem\Pointer;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Filesystem\Pointer\InputPointer;
   7 use Org\Mxchange\CoreFramework\Filesystem\Pointer\OutputPointer;
   8
   9 /**
  10  * An interface for (mostly) file input/output pointers.
  11  *
  12  * @author              Roland Haeder <webmaster@shipsimu.org>
  13  * @version             0.0.0
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
  15  * @license             GNU GPL 3.0 or any newer version
  16  * @link                http://www.shipsimu.org
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  30  */
  31 interface InputOutputPointer extends InputPointer, OutputPointer {
  32         /**
  33          * Rewinds to the beginning of the file
  34          *
  35          * @return      $status         Status of this operation
  36          */
  37         function rewind ();
  38
  39         /**
  40          * Advances to next "block" of bytes
  41          *
  42          * @return      void
  43          */
  44         function next ();
  45
  46         /**
  47          * Checks wether the current entry is valid (not at the end of the file).
  48          * This method will return true if an emptied (nulled) entry has been found.
  49          *
  50          * @return      $isValid        Whether the next entry is valid
  51          */
  52         function valid ();
  53
  54         /**
  55          * Gets current seek position ("key").
  56          *
  57          * @return      $key    Current key in iteration
  58          */
  59         function key ();
  60
  61 }