Binaryiotools Index / Binaryiotools
Auto-generated documentation for binaryiotools module.
- Binaryiotools
- IO
- IO().getitem
- IO().len
- IO().addBytes
- IO().beginContext
- IO().bool16
- IO().bool16
- IO().bool32
- IO().bool32
- IO().bool64
- IO().bool64
- IO().bool8
- IO().bool8
- IO().boolean
- IO().boolean
- IO().byte
- IO().byte
- IO().cString
- IO().cString
- IO().cStringA
- IO().cStringA
- IO().cStringU
- IO().cStringU
- IO().cStringW
- IO().cStringW
- IO().data
- IO().data
- IO().double
- IO().double
- IO().dword
- IO().dword
- IO().endContext
- IO().float32
- IO().float32
- IO().float32be
- IO().float32be
- IO().float32le
- IO().float32le
- IO().float64
- IO().float64
- IO().float64be
- IO().float64be
- IO().float64le
- IO().float64le
- IO().floating
- IO().floating
- IO().getBytes
- IO().i16
- IO().i16
- IO().i16be
- IO().i16be
- IO().i16le
- IO().i16le
- IO().i32
- IO().i32
- IO().i32be
- IO().i32be
- IO().i32le
- IO().i32le
- IO().i64
- IO().i64
- IO().i64be
- IO().i64be
- IO().i64le
- IO().i64le
- IO().i8
- IO().i8
- IO().i8be
- IO().i8be
- IO().i8le
- IO().i8le
- IO().index
- IO().index
- IO().qword
- IO().qword
- IO().setBytes
- IO().sz754
- IO().sz754
- IO().sz754A
- IO().sz754A
- IO().sz754U
- IO().sz754U
- IO().sz754W
- IO().sz754W
- IO().textLine
- IO().textLine
- IO().textLineA
- IO().textLineA
- IO().textLineU
- IO().textLineU
- IO().textLineW
- IO().textLineW
- IO().u16
- IO().u16
- IO().u16be
- IO().u16be
- IO().u16le
- IO().u16le
- IO().u32
- IO().u32
- IO().u32be
- IO().u32be
- IO().u32le
- IO().u32le
- IO().u64
- IO().u64
- IO().u64be
- IO().u64be
- IO().u64le
- IO().u64le
- IO().u8
- IO().u8
- IO().u8be
- IO().u8be
- IO().u8le
- IO().u8le
- IO().unsignedByte
- IO().unsignedByte
- IO().unsignedDword
- IO().unsignedDword
- IO().unsignedQword
- IO().unsignedQword
- IO().unsignedWord
- IO().unsignedWord
- IO().word
- IO().word
- IO
Class to handle i/o to a byte buffer or file-like object.
class IO:
def __init__(
self,
data: bytearray | bytes | None = None,
idx: int = 0,
littleEndian: bool = False,
boolSize: int = 8,
stringEncoding: str = "U",
):
...Get data at a specific idx.
def __getitem__(self, idx: int):
...Length of data.
def __len__(self) -> int:
...Add some raw bytes and advance the index.
alias for setBytes()
bytes- can be a string, bytearray, or another IO object
def addBytes(self, ioBytes: Any):
...Start a new context where the index can be changed all you want...
and when endContext() is called, it will be restored to the current position
def beginContext(self, newIndex: int):
...Get bool16.
@property
def bool16(self) -> bool:
...Set bool16.
@bool16.setter
def bool16(self, ioBool: bool):
...Get bool32.
@property
def bool32(self) -> bool:
...Set bool32.
@bool32.setter
def bool32(self, ioBool: bool):
...Get bool64.
@property
def bool64(self) -> bool:
...Set bool64.
@bool64.setter
def bool64(self, ioBool: bool):
...Get bool8.
@property
def bool8(self) -> bool:
...Set a bool8.
@bool8.setter
def bool8(self, ioBool: bool):
...Return bool.
@property
def boolean(self) -> bool:
...Set bool.
@boolean.setter
def boolean(self, ioBool: bool):
...Get byte.
@property
def byte(self) -> Any:
...Set byte.
@byte.setter
def byte(self, byte: Any):
...Read a sequence of chars until the next null byte.
@property
def cString(self) -> str:
...Set a sequence of chars and add a null byte.
@cString.setter
def cString(self, text: str):
...Read a sequence of chars until the next null byte in ascii.
@property
def cStringA(self) -> str:
...Set a sequence of chars and add a null byte in ascii.
@cStringA.setter
def cStringA(self, text: str):
...Read a sequence of chars until the next null byte in utf-8.
@property
def cStringU(self) -> str:
...Set a sequence of chars and add a null byte in utf-8.
@cStringU.setter
def cStringU(self, text: str):
...Read a sequence of chars until the next null byte in ucs-2.
@property
def cStringW(self) -> str:
...Set a sequence of chars and add a null byte in ucs-2.
@cStringW.setter
def cStringW(self, text: str):
...Return data.
@property
def data(self) -> bytearray:
...Set data.
@data.setter
def data(self, data: bytearray) -> None:
...Get a double.
@property
def double(self) -> float:
...Set a double.
@double.setter
def double(self, floating: float):
...Get a dword.
@property
def dword(self) -> Any:
...Set a dword.
@dword.setter
def dword(self, dword: Any):
...Restore the index to the previous location where it was when beginContext() was called.
def endContext(self):
...Get a float32.
@property
def float32(self) -> float:
...Set a float32.
@float32.setter
def float32(self, float32: float):
...Read the next 32 bit float and advance the index.
@property
def float32be(self) -> float:
...Set a 32 bit float.
@float32be.setter
def float32be(self, float32be: float):
...Read the next 32 bit float and advance the index.
@property
def float32le(self) -> float:
...Set a 32 bit float.
@float32le.setter
def float32le(self, float32le: float):
...Get a float64.
@property
def float64(self) -> float:
...Set a float64.
@float64.setter
def float64(self, float64: float):
...Read the next 64 bit float and advance the index.
@property
def float64be(self) -> float:
...Set a 64 bit float.
@float64be.setter
def float64be(self, float64be: float):
...Read the next 64 bit float and advance the index.
@property
def float64le(self) -> float:
...Set a 64 bit float.
@float64le.setter
def float64le(self, float64le: float):
...Get a float.
@property
def floating(self) -> float:
...Set a float.
@floating.setter
def floating(self, floating: float):
...Grab some raw bytes and advance the index.
def getBytes(self, nbytes: int):
...Get an int16.
@property
def i16(self) -> int:
...Set an int16.
@i16.setter
def i16(self, i16: int):
...Read the next signed int16 and advance the index.
@property
def i16be(self) -> int:
...Set the int16.
@i16be.setter
def i16be(self, i16be: int):
...Read the next signed int16 and advance the index.
@property
def i16le(self) -> int:
...Set the int16.
@i16le.setter
def i16le(self, i16le: int):
...Get an int32.
@property
def i32(self) -> int:
...Set an int32.
@i32.setter
def i32(self, i32: int):
...Read the next signed int32 and advance the index.
@property
def i32be(self) -> int:
...Set the int32.
@i32be.setter
def i32be(self, i32be: int):
...Read the next signed int32 and advance the index.
@property
def i32le(self) -> int:
...Set the int32.
@i32le.setter
def i32le(self, i32le: int):
...Get an int64.
@property
def i64(self) -> int:
...Set an int64.
@i64.setter
def i64(self, i64: int):
...Read the next signed int64 and advance the index.
@property
def i64be(self) -> int:
...Set the int64.
@i64be.setter
def i64be(self, i64be: int):
...Read the next signed int64 and advance the index.
@property
def i64le(self) -> int:
...Set the int64.
@i64le.setter
def i64le(self, i64le: int):
...Get an int8.
@property
def i8(self) -> int:
...Set an int8.
@i8.setter
def i8(self, i8: int):
...Read the next signed int8 and advance the index.
@property
def i8be(self) -> int:
...Set the int8.
@i8be.setter
def i8be(self, i8be: int):
...Read the next signed int8 and advance the index.
@property
def i8le(self) -> int:
...Set the int8.
@i8le.setter
def i8le(self, i8le: int):
...Return data.
@property
def index(self) -> int:
...Set index.
@index.setter
def index(self, index: int) -> None:
...Get a qword.
@property
def qword(self) -> Any:
...Set a qword.
@qword.setter
def qword(self, qword: Any):
...Add some raw bytes and advance the index.
alias for addBytes()
ioBytes- can be a string, bytearray, or another IO object
def setBytes(self, ioBytes: Any):
...sz754.
@property
def sz754(self) -> Any:
...Set sz754.
@sz754.setter
def sz754(self, sz754: Any):
...sz754A.
@property
def sz754A(self) -> Any:
...Set sz754A.
@sz754A.setter
def sz754A(self, sz754: Any):
...sz754U.
@property
def sz754U(self) -> Any:
...Set sz754U.
@sz754U.setter
def sz754U(self, sz754: Any):
...sz754W.
@property
def sz754W(self) -> Any:
...Set sz754W.
@sz754W.setter
def sz754W(self, sz754: Any):
...Read a sequence of chars until the next new line char.
@property
def textLine(self) -> str:
...Set a sequence of chars until the next new line char.
@textLine.setter
def textLine(self, text: str):
...Read a sequence of chars until the next new line char in ascii.
@property
def textLineA(self) -> str:
...Set a sequence of chars until the next new line char in ascii.
@textLineA.setter
def textLineA(self, text: str):
...Read a sequence of chars until the next new line char in utf-8.
@property
def textLineU(self) -> str:
...Set a sequence of chars until the next new line char in utf-8.
@textLineU.setter
def textLineU(self, text: str):
...Read a sequence of chars until the next new line char in ucs-2.
@property
def textLineW(self) -> str:
...Set a sequence of chars until the next new line char in ucs-2.
@textLineW.setter
def textLineW(self, text: str):
...Get an uint16.
@property
def u16(self) -> int:
...Set an unint16.
@u16.setter
def u16(self, u16: int):
...Read the next uint16 and advance the index.
@property
def u16be(self) -> int:
...Set the uint16.
@u16be.setter
def u16be(self, u16be: int):
...Read the next uint16 and advance the index.
@property
def u16le(self) -> int:
...Set the uint16.
@u16le.setter
def u16le(self, u16le: int):
...Get a uint32.
@property
def u32(self) -> int:
...Set a unint32.
@u32.setter
def u32(self, u32: int):
...Read the next uint32 and advance the index.
@property
def u32be(self) -> int:
...Set the uint32.
@u32be.setter
def u32be(self, u32be: int):
...Read the next uint32 and advance the index.
@property
def u32le(self) -> int:
...Set the uint32.
@u32le.setter
def u32le(self, u32le: int):
...Get a uint64.
@property
def u64(self) -> int:
...Set a uint64.
@u64.setter
def u64(self, u64: int):
...Read the next uint64 and advance the index.
@property
def u64be(self) -> int:
...Set the uint64.
@u64be.setter
def u64be(self, u64be: int):
...Read the next uint64 and advance the index.
@property
def u64le(self) -> int:
...Set the uint64.
@u64le.setter
def u64le(self, u64le: int):
...Get an unsigned int.
@property
def u8(self) -> int:
...Set an unsigned int.
@u8.setter
def u8(self, u8: int):
...Read the next uint8 and advance the index.
@property
def u8be(self) -> int:
...Set the uint8.
@u8be.setter
def u8be(self, u8be: int):
...Read the next uint8 and advance the index.
@property
def u8le(self) -> int:
...Set the uint8.
@u8le.setter
def u8le(self, u8le: int):
...Get unsigned byte.
@property
def unsignedByte(self) -> Any:
...Set unsigned byte.
@unsignedByte.setter
def unsignedByte(self, byte: Any):
...Get a unsigned dword.
@property
def unsignedDword(self) -> Any:
...Set an unsigned dword.
@unsignedDword.setter
def unsignedDword(self, unsignedDword: Any):
...Get an unsigned qword.
@property
def unsignedQword(self) -> Any:
...Set an unsigned qword.
@unsignedQword.setter
def unsignedQword(self, unsignedQword: Any):
...Get an unsigned word.
@property
def unsignedWord(self) -> Any:
...Set an unsigned word.
@unsignedWord.setter
def unsignedWord(self, unsignedWord: Any):
...Get a word.
@property
def word(self) -> Any:
...Set a word.
@word.setter
def word(self, word: Any):
...