3 namespace Org\Mxchange\CoreFramework\Filesystem\Pointer;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Filesystem\Pointer\InputPointer;
7 use Org\Mxchange\CoreFramework\Filesystem\Pointer\OutputPointer;
10 * An interface for (mostly) file input/output pointers.
12 * @author Roland Haeder <webmaster@shipsimu.org>
14 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
15 * @license GNU GPL 3.0 or any newer version
16 * @link http://www.shipsimu.org
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.
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.
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/>.
31 interface InputOutputPointer extends InputPointer, OutputPointer {
33 * Rewinds to the beginning of the file
35 * @return $status Status of this operation
40 * Advances to next "block" of bytes
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.
50 * @return $isValid Whether the next entry is valid
55 * Gets current seek position ("key").
57 * @return $key Current key in iteration