Module prototypes :: Class STRING

[frames] | no frames]

Class STRING

       object --+    
                |    
BaseProtogenClass --+
                    |
                   STRING

A text string DEPRECATED USE USTRING

Instance Methods

__init__(self, *args, **kwargs)
A string value can be specified to this constructor, or in the value keyword arg.

source code

_update(self, args, kwargs)

source code

readfrombuffer(self, buf)
Get our value from the buffer

source code

writetobuffer(self, buf)
Scribble ourselves to the buf

source code

packetsize(self)
Returns size in bytes that we occupy

source code

getvalue(self)
Returns the string we are

source code

Inherited from BaseProtogenClass: autologread, autologwrite, iscontainer, packetspan, update

Inherited from BaseProtogenClass (private): _complainaboutunusedargs, _consumekw, _ismostderived

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Properties

Inherited from object: __class__

Method Details

init(self, *args, **kwargs)
(Constructor)

A string value can be specified to this constructor, or in the value keyword arg.

Parameters:

constant - (Optional) A constant value. All reads must have this value
terminator - (Default=0) The string terminator (or None). If set there will always be a terminator when writing. The terminator is not returned when getting the value.
pad - (Default=0) The padding byte if fixed length when writing, or stripped off when reading
sizeinbytes - (Optional) Set if fixed length. If not set, then the terminator will be used to find the end of strings on reading. If not set and the terminator is None, then reads will be entire rest of buffer.
maxsizeinbytes - (Optional) Max string length. Used together with terminator to limit the max length of the value. TODO: Need to add this to USTRING also.
default - (Optional) Our default value
raiseonunterminatedread - (Default True) raise NotTerminatedException if there is no terminator on the value being read in. terminator must also be set.
raiseontruncate - (Default True) raise ValueLengthException if the supplied value is too large to fit within sizeinbytes.
value - (Optional) Value
pascal - (Default False) The string is preceded with one byte giving the length of the string (including terminator if there is one)

Overrides: object.__init__

_update(self, args, kwargs)

Overrides: BaseProtogenClass._update

readfrombuffer(self, buf)

Get our value from the buffer

Overrides: BaseProtogenClass.readfrombuffer: (inherited documentation)

writetobuffer(self, buf)

Scribble ourselves to the buf

Overrides: BaseProtogenClass.writetobuffer: (inherited documentation)

packetsize(self)

Returns size in bytes that we occupy

Overrides: BaseProtogenClass.packetsize: (inherited documentation)

getvalue(self)

Returns the string we are

Overrides: BaseProtogenClass.getvalue