Classes List

Swift_CharacterStream

 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 
 86 
 87 
 88 
<?php

/* * This file is part of SwiftMailer. * (c) 2004-2009 Chris Corbyn * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


/** * An abstract means of reading and writing data in terms of characters as opposed * to bytes. * * Classes implementing this interface may use a subsystem which requires less * memory than working with large strings of data. * * @author Chris Corbyn */
interface Swift_CharacterStream
{
    /** * Set the character set used in this CharacterStream. * * @param string $charset */
    public function setCharacterSet($charset);

    /** * Set the CharacterReaderFactory for multi charset support. */
    public function setCharacterReaderFactory(Swift_CharacterReaderFactory $factory);

    /** * Overwrite this character stream using the byte sequence in the byte stream. * * @param Swift_OutputByteStream $os output stream to read from */
    public function importByteStream(Swift_OutputByteStream $os);

    /** * Import a string a bytes into this CharacterStream, overwriting any existing * data in the stream. * * @param string $string */
    public function importString($string);

    /** * Read $length characters from the stream and move the internal pointer * $length further into the stream. * * @param int $length * * @return string */
    public function read($length);

    /** * Read $length characters from the stream and return a 1-dimensional array * containing there octet values. * * @param int $length * * @return int[] */
    public function readBytes($length);

    /** * Write $chars to the end of the stream. * * @param string $chars */
    public function write($chars);

    /** * Move the internal pointer to $charOffset in the stream. * * @param int $charOffset */
    public function setPointer($charOffset);

    /** * Empty the stream and reset the internal pointer. */
    public function flushContents();
}