tivars.types.list.ListName

class documentation

class ListName(TokenizedString): (source)

Converter for the name section of lists

List names can be L1 - L6 or a string of five alphanumeric characters that do not start with a digit. The special name and token IDList is also used (but is planned to be relegated to a separate type).

Class Method	`get`	Converts `bytes` -> `str` as done by the memory viewer
Class Method	`set`	Converts `str` -> `bytes` to match appearance in the memory viewer

@classmethod
def get(cls, data: bytes, **kwargs) -> _T: (source) ¶

overrides tivars.tokenizer.TokenizedString.get

Converts bytes -> str as done by the memory viewer

Parameters
data:`bytes`	The raw bytes to convert
**kwargs	Undocumented
Returns
`_T`	The list name contained in `data`

@classmethod
def set(cls, value: _T, **kwargs) -> bytes: (source) ¶

overrides tivars.tokenizer.TokenizedString.set

Converts str -> bytes to match appearance in the memory viewer

Parameters
value:`_T`	The value to convert
**kwargs	Undocumented
Returns
`bytes`	The name encoding of `value`