prototypes.USTRING

Module prototypes :: Class USTRING

[show private | hide private]

Type USTRING

       object --+    
                |    
BaseProtogenClass --+
                    |
                   USTRING

A text string that supports configurable encodings

Method Summary
	`__init__(self, args, *kwargs)` A string value can be specified to this constructor, or in the value keyword arg.
	`convert_for_write(self)`
	`getvalue(self)` Returns the string we are
	`packetsize(self)` Returns size in bytes that we occupy
	`readfrombuffer(self, buf)` Get our value from the buffer
	`writetobuffer(self, buf)` Scribble ourselves to the buf
Inherited from BaseProtogenClass
	`autologread(self, buf, logtitle)`
	`autologwrite(self, buf, logtitle)`
	`iscontainer(self)` Do we contain fields?
	`packetspan(self)` Returns tuple of begining,end offsets from last packet we were read or written from.
	`update(self, args, *kwargs)`
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Method Details

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

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

Keyword 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.; terminator_length - (Default=1) (min:1, max:4)The length of the string terminator. This keyword is not used if the terminator is None. Multi-byte terminators are treated as LSB when read from the phone.; 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.; 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); encoding - (Default 'ascii') The charset to use when reading/writing to a buffer; read_encoding - (Default keyword:encoding) The charset to use when reading from a buffer; write_encoding - (Default keyword:encoding) The charset to use when writing to a buffer