Skip to main content

ReaderKind

Enum ReaderKind 

Source
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

Source

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.

Source

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).

Source

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.

Source

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.

Source

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.

Source

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).

Trait Implementations§

Source§

impl Clone for ReaderKind

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for ReaderKind

Source§

impl Debug for ReaderKind

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ReaderKind

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for ReaderKind

Source§

impl Hash for ReaderKind

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ReaderKind

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ReaderKind

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.