mail/src/StreamInterface.php at master · genkgo/mail · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
<?php
declare(strict_types=1);

namespace Genkgo\Mail;

interface StreamInterface
{
    /**
     * @return string
     */
    public function __toString(): string;

    public function close(): void;

    /**
     * @return mixed
     */
    public function detach();

    /**
     * @return int|null
     */
    public function getSize() : ?int ;

    /**
     * @return int
     * @throws \RuntimeException
     */
    public function tell(): int;

    /**
     * @return bool
     */
    public function eof(): bool;

    /**
     * @return bool
     */
    public function isSeekable(): bool;

    /**
     * @param int $offset
     * @param int $whence
     * @return int
     */
    public function seek(int $offset, int $whence = SEEK_SET): int;

    /**
     * @return bool
     */
    public function rewind(): bool;

    /**
     * @return bool
     */
    public function isWritable(): bool;

    /**
     * @param string $string
     * @return int
     */
    public function write($string): int;

    /**
     * @return bool
     */
    public function isReadable(): bool;

    /**
     * @param int $length
     * @return string
     */
    public function read(int $length): string;

    /**
     * @return string
     */
    public function getContents(): string;

    /**
     * @param array<int, string> $keys
     * @return array<string, mixed>
     */
    public function getMetadata(array $keys = []): array;
}