Added more methods (required).
[core.git] / inc / classes / interfaces / io / pointer / io / class_InputOutputPointer.php
index 6c2de09c78a1a8e49c6156b3d563e8ceca0036b8..0cb98dd847801d3cb036a5701bb0d4192b2fe342 100644 (file)
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 interface InputOutputPointer extends InputPointer, OutputPointer {
+       /**
+        * Rewinds to the beginning of the file
+        *
+        * @return      $status         Status of this operation
+        */
+       function rewind ();
+
+       /**
+        * Advances to next "block" of bytes
+        *
+        * @return      void
+        * @todo        This method will load large but empty files in a whole
+        */
+       function next ();
+
+       /**
+        * Checks wether the current entry is valid (not at the end of the file).
+        * This method will return TRUE if an emptied (nulled) entry has been found.
+        *
+        * @return      $isValid        Whether the next entry is valid
+        */
+       function valid ();
+
+       /**
+        * Gets current seek position ("key").
+        *
+        * @return      $key    Current key in iteration
+        */
+       function key ();
 }
 
 // [EOF]