Docs For Class Swift_CharacterStream

Swift_CharacterStream_ArrayCharacterStream __construct(
Swift_CharacterReaderFactory
$factory, string
$charset)

Create a new CharacterStream with the given $chars, if set.

Tags:

access:

public

Parameters:

Swift_CharacterReaderFactory	$factory	for loading validators
string	$charset	used in the stream

[ Top ]

void flushContents(
)

Empty the stream and reset the internal pointer.

Tags:

access:

public

Implementation of:

Swift_CharacterStream::flushContents(): Empty the stream and reset the internal pointer.

[ Top ]

void importByteStream(
Swift_OutputByteStream
$os)

Overwrite this character stream using the byte sequence in the byte stream.

Tags:

access:

public

Implementation of:

Swift_CharacterStream::importByteStream(): Overwrite this character stream using the byte sequence in the byte stream.

Parameters:

Swift_OutputByteStream

$os

output stream to read from

[ Top ]

void importString(
string
$string)

Import a string a bytes into this CharacterStream, overwriting any existing data in the stream.

Tags:

access:

public

Implementation of:

Swift_CharacterStream::importString(): Import a string a bytes into this CharacterStream, overwriting any existing data in the stream.

Parameters:

string

$string

[ Top ]

string read(
int
$length)

Read $length characters from the stream and move the internal pointer $length further into the stream.

Tags:

access:

public

Implementation of:

Swift_CharacterStream::read(): Read $length characters from the stream and move the internal pointer $length further into the stream.

Parameters:

int

$length

[ Top ]

int[] readBytes(
int
$length)

Read $length characters from the stream and return a 1-dimensional array containing there octet values.

Tags:

access:

public

Implementation of:

Swift_CharacterStream::readBytes(): Read $length characters from the stream and return a 1-dimensional array containing there octet values.

Parameters:

int

$length

[ Top ]

void setCharacterReaderFactory(
Swift_CharacterReaderFactory
$factory)

Set the CharacterReaderFactory for multi charset support.

Tags:

access:

public

Implementation of:

Swift_CharacterStream::setCharacterReaderFactory(): Set the CharacterReaderFactory for multi charset support.

Parameters:

Swift_CharacterReaderFactory

$factory

[ Top ]

void setCharacterSet(
string
$charset)

Set the character set used in this CharacterStream.

Tags:

access:

public

Implementation of:

Swift_CharacterStream::setCharacterSet(): Set the character set used in this CharacterStream.

Parameters:

string

$charset

[ Top ]

void setPointer(
int
$charOffset)

Move the internal pointer to $charOffset in the stream.

Tags:

access:

public

Implementation of:

Swift_CharacterStream::setPointer(): Move the internal pointer to $charOffset in the stream.

Parameters:

int

$charOffset

[ Top ]

void write(
string
$chars)

Write $chars to the end of the stream.

Tags:

access:

public

Implementation of:

Swift_CharacterStream::write(): Write $chars to the end of the stream.

Parameters:

string

$chars

[ Top ]

Class: Swift_CharacterStream_ArrayCharacterStream

Class Overview

Author(s):

Methods

Class Details

Tags:

Class Methods

constructor __construct [line 54]

Tags:

Parameters:

method flushContents [line 286]

Tags:

method importByteStream [line 86]

Tags:

Parameters:

method importString [line 123]

Tags:

Parameters:

method read [line 135]

Tags:

Parameters:

method readBytes [line 168]

Tags:

Parameters:

method setCharacterReaderFactory [line 76]

Tags:

Parameters:

method setCharacterSet [line 66]

Tags:

Parameters:

method setPointer [line 270]

Tags:

Parameters:

method write [line 192]

Tags:

Parameters: