codecs.IncrementalEncoder Class Reference

Inheritance diagram for codecs.IncrementalEncoder:

Public Member Functions
def	__init__
def	encode
def	reset
def	getstate
def	setstate

Public Attributes
	errors
	buffer

Detailed Description

An IncrementalEncoder encodes an input in multiple steps. The input can be
passed piece by piece to the encode() method. The IncrementalEncoder remembers
the state of the Encoding process between calls to encode().

Constructor & Destructor Documentation

def codecs.IncrementalEncoder.__init__	(		self,
			errors = 'strict'
	)

Creates an IncrementalEncoder instance.

The IncrementalEncoder may use different error handling schemes by
providing the errors keyword argument. See the module docstring
for a list of possible values.

Member Function Documentation

def codecs.IncrementalEncoder.encode	(		self,
			input,
			final = False
	)

Encodes input and returns the resulting object.

def codecs.IncrementalEncoder.getstate

(

self

)

Return the current state of the encoder.

def codecs.IncrementalEncoder.reset

(

self

)

Resets the encoder to the initial state.

def codecs.IncrementalEncoder.setstate	(		self,
			state
	)

Set the current state of the encoder. state must have been
returned by getstate().

Member Data Documentation

codecs.IncrementalEncoder.buffer

codecs.IncrementalEncoder.errors

Creates an IncrementalEncoder instance.

The IncrementalEncoder may use different error handling schemes by
providing the errors keyword argument. See the module docstring
for a list of possible values.

---

The documentation for this class was generated from the following file:

• orbits/lib/python2.7/codecs.py