| | |
- runtimepy.primitives.base.Primitive(typing.Generic)
-
- BooleanPrimitive
Bool = class BooleanPrimitive(runtimepy.primitives.base.Primitive) |
| |
Bool(value: bool = False) -> None
A simple primitive class for booleans.
|
| |
- Method resolution order:
- BooleanPrimitive
- runtimepy.primitives.base.Primitive
- typing.Generic
- builtins.object
Methods defined here:
- __init__(self, value: bool = False) -> None
- Initialize this boolean primitive.
- clear(self) -> None
- Coerce the underlying value to false.
- set(self) -> None
- Coerce the underlying value to true.
- toggle(self) -> None
- Toggle the underlying value.
Data and other attributes defined here:
- __annotations__ = {'value': <class 'bool'>}
- __orig_bases__ = (runtimepy.primitives.base.Primitive[bool],)
- __parameters__ = ()
- kind = <runtimepy.primitives.types.bool.BooleanType object>
Methods inherited from runtimepy.primitives.base.Primitive:
- __bool__(self) -> bool
- Use the underlying value for boolean evaluation.
- __bytes__(self) -> bytes
- Convert this instance to a byte array.
- __call__(self, value: ~T = None) -> ~T
- A callable interface for setting and getting the underlying value.
- __copy__(self) -> 'Primitive[T]'
- Make a copy of this primitive.
- __eq__(self, other) -> bool
- Determine if this instance is equivalent to the provided argument.
- __hash__(self) -> int
- A hash for this instance.
- __str__(self) -> str
- Get this primitive's value as a string.
- age_ns(self, now: int = None) -> int
- Get the age of this primitive's value in nanoseconds.
- age_str(self, now: int = None) -> str
- Get the age of this primitive's value as a string.
- binary(self, byte_order: runtimepy.primitives.byte_order.ByteOrder = None) -> bytes
- Convert this instance to a byte array.
- copy(self) -> 'Primitive[T]'
- A simple wrapper for copy.
- from_stream(self, stream: <class 'BinaryIO'>, byte_order: runtimepy.primitives.byte_order.ByteOrder = None) -> ~T
- Update this primitive from a stream and return the new value.
- register_callback(self, callback: Callable[[~T, ~T], NoneType], once: bool = False) -> int
- Register a callback and return an identifier for it.
- remove_callback(self, callback_id: int) -> bool
- Remove a callback if one is registered with this identifier.
- to_stream(self, stream: <class 'BinaryIO'>, byte_order: runtimepy.primitives.byte_order.ByteOrder = None) -> int
- Write this primitive to a stream.
- update(self, data: bytes, byte_order: runtimepy.primitives.byte_order.ByteOrder = None) -> ~T
- Update this primitive from a bytes object.
Class methods inherited from runtimepy.primitives.base.Primitive:
- decode(data: bytes, byte_order: runtimepy.primitives.byte_order.ByteOrder = None) -> ~T from builtins.type
- Decode a primitive of this type from provided data.
- encode(value: ~T, byte_order: runtimepy.primitives.byte_order.ByteOrder = None) -> bytes from builtins.type
- Create a bytes instance based on this primitive type.
- read(stream: <class 'BinaryIO'>, byte_order: runtimepy.primitives.byte_order.ByteOrder = None) -> ~T from builtins.type
- Read a primitive from the provided stream based on this primitive type.
- write(value: ~T, stream: <class 'BinaryIO'>, byte_order: runtimepy.primitives.byte_order.ByteOrder = None) -> int from builtins.type
- Write a primitive to the stream based on this type.
Readonly properties inherited from runtimepy.primitives.base.Primitive:
- size
- Get the size of this primitive.
Data descriptors inherited from runtimepy.primitives.base.Primitive:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
- scaled
- Get this primitive as a scaled value.
- value
- Obtain the underlying value.
Data and other attributes inherited from runtimepy.primitives.base.Primitive:
- byte_order = <ByteOrder.NETWORK: 4>
Class methods inherited from typing.Generic:
- __class_getitem__(...) from builtins.type
- Parameterizes a generic class.
At least, parameterizing a generic class is the *main* thing this
method does. For example, for some generic class `Foo`, this is called
when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
However, note that this method is also called when defining generic
classes in the first place with `class Foo[T]: ...`.
- __init_subclass__(...) from builtins.type
- Function to initialize subclasses.
|
class BooleanPrimitive(runtimepy.primitives.base.Primitive) |
| |
BooleanPrimitive(value: bool = False) -> None
A simple primitive class for booleans.
|
| |
- Method resolution order:
- BooleanPrimitive
- runtimepy.primitives.base.Primitive
- typing.Generic
- builtins.object
Methods defined here:
- __init__(self, value: bool = False) -> None
- Initialize this boolean primitive.
- clear(self) -> None
- Coerce the underlying value to false.
- set(self) -> None
- Coerce the underlying value to true.
- toggle(self) -> None
- Toggle the underlying value.
Data and other attributes defined here:
- __annotations__ = {'value': <class 'bool'>}
- __orig_bases__ = (runtimepy.primitives.base.Primitive[bool],)
- __parameters__ = ()
- kind = <runtimepy.primitives.types.bool.BooleanType object>
Methods inherited from runtimepy.primitives.base.Primitive:
- __bool__(self) -> bool
- Use the underlying value for boolean evaluation.
- __bytes__(self) -> bytes
- Convert this instance to a byte array.
- __call__(self, value: ~T = None) -> ~T
- A callable interface for setting and getting the underlying value.
- __copy__(self) -> 'Primitive[T]'
- Make a copy of this primitive.
- __eq__(self, other) -> bool
- Determine if this instance is equivalent to the provided argument.
- __hash__(self) -> int
- A hash for this instance.
- __str__(self) -> str
- Get this primitive's value as a string.
- age_ns(self, now: int = None) -> int
- Get the age of this primitive's value in nanoseconds.
- age_str(self, now: int = None) -> str
- Get the age of this primitive's value as a string.
- binary(self, byte_order: runtimepy.primitives.byte_order.ByteOrder = None) -> bytes
- Convert this instance to a byte array.
- copy(self) -> 'Primitive[T]'
- A simple wrapper for copy.
- from_stream(self, stream: <class 'BinaryIO'>, byte_order: runtimepy.primitives.byte_order.ByteOrder = None) -> ~T
- Update this primitive from a stream and return the new value.
- register_callback(self, callback: Callable[[~T, ~T], NoneType], once: bool = False) -> int
- Register a callback and return an identifier for it.
- remove_callback(self, callback_id: int) -> bool
- Remove a callback if one is registered with this identifier.
- to_stream(self, stream: <class 'BinaryIO'>, byte_order: runtimepy.primitives.byte_order.ByteOrder = None) -> int
- Write this primitive to a stream.
- update(self, data: bytes, byte_order: runtimepy.primitives.byte_order.ByteOrder = None) -> ~T
- Update this primitive from a bytes object.
Class methods inherited from runtimepy.primitives.base.Primitive:
- decode(data: bytes, byte_order: runtimepy.primitives.byte_order.ByteOrder = None) -> ~T from builtins.type
- Decode a primitive of this type from provided data.
- encode(value: ~T, byte_order: runtimepy.primitives.byte_order.ByteOrder = None) -> bytes from builtins.type
- Create a bytes instance based on this primitive type.
- read(stream: <class 'BinaryIO'>, byte_order: runtimepy.primitives.byte_order.ByteOrder = None) -> ~T from builtins.type
- Read a primitive from the provided stream based on this primitive type.
- write(value: ~T, stream: <class 'BinaryIO'>, byte_order: runtimepy.primitives.byte_order.ByteOrder = None) -> int from builtins.type
- Write a primitive to the stream based on this type.
Readonly properties inherited from runtimepy.primitives.base.Primitive:
- size
- Get the size of this primitive.
Data descriptors inherited from runtimepy.primitives.base.Primitive:
- __dict__
- dictionary for instance variables
- __weakref__
- list of weak references to the object
- scaled
- Get this primitive as a scaled value.
- value
- Obtain the underlying value.
Data and other attributes inherited from runtimepy.primitives.base.Primitive:
- byte_order = <ByteOrder.NETWORK: 4>
Class methods inherited from typing.Generic:
- __class_getitem__(...) from builtins.type
- Parameterizes a generic class.
At least, parameterizing a generic class is the *main* thing this
method does. For example, for some generic class `Foo`, this is called
when we do `Foo[int]` - there, with `cls=Foo` and `params=int`.
However, note that this method is also called when defining generic
classes in the first place with `class Foo[T]: ...`.
- __init_subclass__(...) from builtins.type
- Function to initialize subclasses.
| |