pub enum ReaderKind {
Memory,
Stream,
BytesIo,
}Expand description
Which of UnityPy’s readers a file is read with (module docs).
Variants§
Memory
EndianBinaryReader_Memoryview: bytes. What UnityPy is handed as
bytes (crate::env::Source::Bytes and crate::env::Source::Fetch),
and every entry of a container.
Stream
EndianBinaryReader_Streamable over the buffered file Environment
opens for a path: a top-level crate::env::Source::Path.
BytesIo
Stream reader backed by io.BytesIO: any negative read size means EOF.
Implementations§
Source§impl ReaderKind
impl ReaderKind
Sourcepub fn seek(self, pos: i128) -> Result<i128, StreamRefusal>
pub fn seek(self, pos: i128) -> Result<i128, StreamRefusal>
Position = pos: the position it leaves, or the stream reader’s
refusal of a negative one or one at or above 2^63.
Sourcepub fn align(self, pos: i128, n: u32) -> Result<i128, StreamRefusal>
pub fn align(self, pos: i128, n: u32) -> Result<i128, StreamRefusal>
align_stream(n) at pos: Position += (n - Position % n) % n
(py_align), an assignment through the Position setter
(streams/EndianBinaryReader.py:155-156), so the stream reader
refuses a result its seek cannot take, as Self::seek does: at
2^63 or more (from a position within n - 1 of 2^63 - 1).
Sourcepub fn read(
self,
len: usize,
pos: i128,
size: i64,
) -> Result<(Range<usize>, i128), StreamRefusal>
pub fn read( self, len: usize, pos: i128, size: i64, ) -> Result<(Range<usize>, i128), StreamRefusal>
read(size) at pos over len bytes: the bytes’ range and the new
position. The memory reader’s is py_read; the stream reader’s
reads what exists from pos (never negative on a stream, as
Self::seek refuses that) and moves by what it read.
Sourcepub fn read_u64(
self,
len: usize,
pos: i128,
size: u64,
) -> Result<(Range<usize>, i128), StreamRefusal>
pub fn read_u64( self, len: usize, pos: i128, size: u64, ) -> Result<(Range<usize>, i128), StreamRefusal>
read(size) for a size a caller holds as a u64 (a resource’s): on
the memory reader a size past i64::MAX slices as i64::MAX does,
and the stream reader refuses it.
Sourcepub fn unpack(self, len: usize, pos: i128, n: usize) -> (Option<usize>, i128)
pub fn unpack(self, len: usize, pos: i128, n: usize) -> (Option<usize>, i128)
The reader’s own fixed-width read of n bytes (reader.read_int()
and the like) at pos over len bytes: the start of its n bytes,
or None where it raises, and the position after it. The memory
reader’s is struct.unpack_from(view, Position) (py_unpack_from),
which moves the position by n on success only; the stream reader’s
is struct.unpack(stream.read(n)), which moves it by what it read.
Sourcepub fn string_to_null(
self,
data: &[u8],
pos: i128,
max_length: usize,
) -> Option<(Range<usize>, i128)>
pub fn string_to_null( self, data: &[u8], pos: i128, max_length: usize, ) -> Option<(Range<usize>, i128)>
read_string_to_null(max_length) at pos over data: the string’s
range and the new position, or None where it raises (module docs:
the stream reader raises only past the end with max_length above
0).