1<?php
2
3/**
4 * Hoa
5 *
6 *
7 * @license
8 *
9 * New BSD License
10 *
11 * Copyright © 2007-2017, Hoa community. All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions are met:
15 *     * Redistributions of source code must retain the above copyright
16 *       notice, this list of conditions and the following disclaimer.
17 *     * Redistributions in binary form must reproduce the above copyright
18 *       notice, this list of conditions and the following disclaimer in the
19 *       documentation and/or other materials provided with the distribution.
20 *     * Neither the name of the Hoa nor the names of its contributors may be
21 *       used to endorse or promote products derived from this software without
22 *       specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37namespace Hoa\Stream\IStream;
38
39/**
40 * Interface \Hoa\Stream\IStream\Pointable.
41 *
42 * Interface for pointable input/output.
43 *
44 * @copyright  Copyright © 2007-2017 Hoa community
45 * @license    New BSD License
46 */
47interface Pointable extends Stream
48{
49    /**
50     * Set position equal to $offset bytes.
51     *
52     * @const int
53     */
54    const SEEK_SET     = SEEK_SET;
55
56    /**
57     * Set position to current location plus $offset.
58     *
59     * @const int
60     */
61    const SEEK_CURRENT = SEEK_CUR;
62
63    /**
64     * Set position to end-of-file plus $offset.
65     *
66     * @const int
67     */
68    const SEEK_END     = SEEK_END;
69
70
71
72    /**
73     * Rewind the position of a stream pointer.
74     *
75     * @return  bool
76     */
77    public function rewind();
78
79    /**
80     * Seek on a stream pointer.
81     *
82     * @param   int     $offset    Offset (negative value should be supported).
83     * @param   int     $whence    Whence, use the self::SEEK_* constants.
84     * @return  int
85     */
86    public function seek($offset, $whence = self::SEEK_SET);
87
88    /**
89     * Get the current position of the stream pointer.
90     *
91     * @return  int
92     */
93    public function tell();
94}
95