class documentation

class LittleEndian(Integer):

View In Hierarchy

An integer type that wraps an inner integer type and forces its endianness to little-endian.

Method __init__ Undocumented
Method size_bytes The minimal number of bytes necessary to hold an instance of this integer type.
Property endianness Property: The endianness of this integer type. Will always be little-endian.
Property signedness Property: The signedness of this integer type.
Property inner Property: The inner integer type
Method is_context_sensitive Whether the context argument needed by some methods actually has an effect.
Instance Variable _integer_type Undocumented

Inherited from Integer:

Method _construct_type Return the underlying construct instance

Inherited from Type (via Integer):

Method parse Parses the value of an instance of this type from a raw buffer, possibly depending on the context.
Method to_bytes Build a byte buffer from a value of this type.
def __init__(self, integer_type):

Undocumented

_integer_type =

Undocumented

def size_bytes(self, context=None):

The minimal number of bytes necessary to hold an instance of this integer type.

Information

ParameterscontextThe context object. See package documentation.
ReturnsAn integer.
@property
endianness =

Property: The endianness of this integer type. Will always be little-endian.

Information

ReturnsAn Endianness.Little instance.
@property
signedness =

Property: The signedness of this integer type.

Information

ReturnsA Signedness instance.
@property
inner =

Property: The inner integer type

Information

ReturnsA type from reven2.types.
def is_context_sensitive(self):

Whether the context argument needed by some methods actually has an effect.

Types that return False to this method are context-insensitive types. You can safely pass any object as context parameter (including None) to the methods of such type.

Note that the context-sensitivity of a type may change in the future.

Examples

Getting the size of a type without needing a context for context-insensitive types: >>> types.U32.is_context_sensitive() False >>> types.U32.size_bytes(context=None) 4 >>> array32_12 = types.Array(types.U32, 12) >>> array32_12.is_context_sensitive() False >>> array32_12.size_bytes() # context=None by default 48

Context-sensitive types may raise errors when attempting to get the size without a context: >>> types.USize.is_context_sensitive() True >>> types.USize.size_bytes(context=None) ValueError: Please provide a context when using a context-sensitive type

API Documentation for reven2, generated by pydoctor 21.2.2 at 2022-03-08 15:23:15.