Package encodings :: Module utf_8_sig :: Class StreamWriter

Class StreamWriter

   codecs.Codec --+    
                  |    
codecs.StreamWriter --+
                      |
                     StreamWriter

Instance Methods

[hide private]

reset(self)
Flushes and resets the codec buffers used for keeping state.

encode(self, input, errors='strict')
Encodes the object input and returns a tuple (output object, length consumed).

Inherited from codecs.StreamWriter: __enter__, __exit__, __getattr__, __init__, write, writelines

Inherited from codecs.Codec: decode

Method Details

[hide private]

reset(self)

Flushes and resets the codec buffers used for keeping state.

Calling this method should ensure that the data on the output is put into a clean state, that allows appending of new fresh data without having to rescan the whole stream to recover state.

Overrides: codecs.StreamWriter.reset: (inherited documentation)

encode(self, input, errors=`'strict'`)

Encodes the object input and returns a tuple (output object, length consumed).

errors defines the error handling to apply. It defaults to 'strict' handling.

The method may not store state in the Codec instance. Use StreamCodec for codecs which have to keep state in order to make encoding/decoding efficient.

The encoder must be able to handle zero length input and return an empty object of the output object type in this situation.

Overrides: codecs.Codec.encode: (inherited documentation)

Class StreamWriter

reset(self)

encode(self, input, errors='strict')

encode(self, input, errors=`'strict'`)