Struct Entry

Source
struct Entry<T: Read + Seek> {
    header: DatFileHeader,
    reader: Arc<Mutex<T>>,
    pos: usize,
    script_type: Option<ScriptType>,
}
Available on crate features circus and circus-arc only.

Fields§

§header: DatFileHeader§reader: Arc<Mutex<T>>§pos: usize§script_type: Option<ScriptType>

Trait Implementations§

Source§

impl<T: Read + Seek> ArchiveContent for Entry<T>

Source§

fn name(&self) -> &str

Returns the name of the file in the archive.
Source§

fn script_type(&self) -> Option<&ScriptType>

Returns the script type if the file is a script.
Source§

fn is_script(&self) -> bool

Returns true if the file is a script.
Source§

fn data(&mut self) -> Result<Vec<u8>>

Returns the data of the file as a vector of bytes.
Source§

fn to_data<'a>(&'a mut self) -> Result<Box<dyn ReadSeek + 'a>>

Returns a reader that supports reading and seeking.
Source§

impl<T: Read + Seek> Read for Entry<T>

Source§

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
1.36.0 · Source§

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers. Read more
Source§

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Reader has an efficient read_vectored implementation. Read more
1.0.0 · Source§

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf. Read more
1.0.0 · Source§

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf. Read more
1.6.0 · Source§

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf. Read more
Source§

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Pull some bytes from this source into the specified buffer. Read more
Source§

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Reads the exact number of bytes required to fill cursor. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adaptor for this instance of Read. Read more
1.0.0 · Source§

fn bytes(self) -> Bytes<Self>
where Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more
1.0.0 · Source§

fn chain<R>(self, next: R) -> Chain<Self, R>
where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another. Read more
1.0.0 · Source§

fn take(self, limit: u64) -> Take<Self>
where Self: Sized,

Creates an adapter which will read at most limit bytes from it. Read more
Source§

impl<T: Read + Seek> Seek for Entry<T>

Source§

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream. Read more
Source§

fn stream_position(&mut self) -> Result<u64>

Returns the current seek position from the start of the stream. Read more
1.55.0 · Source§

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream. Read more
Source§

fn stream_len(&mut self) -> Result<u64, Error>

🔬This is a nightly-only experimental API. (seek_stream_len)
Returns the length of this stream (in bytes). Read more
1.80.0 · Source§

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Entry<T>

§

impl<T> RefUnwindSafe for Entry<T>

§

impl<T> Send for Entry<T>
where T: Send,

§

impl<T> Sync for Entry<T>
where T: Send,

§

impl<T> Unpin for Entry<T>

§

impl<T> UnwindSafe for Entry<T>

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Peek for T
where T: Read + Seek,

Source§

fn peek(&mut self, buf: &mut [u8]) -> Result<usize, Error>

Peeks data from the reader into the provided buffer. Returns the number of bytes read.
Source§

fn peek_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Peeks data from the reader into the provided buffer. Returns an error if the buffer is not filled completely.
Source§

fn peek_at(&mut self, offset: u64, buf: &mut [u8]) -> Result<usize, Error>

Peeks data from the reader at a specific offset into the provided buffer. Returns the number of bytes read.
Source§

fn peek_exact_at(&mut self, offset: u64, buf: &mut [u8]) -> Result<(), Error>

Peeks data from the reader at a specific offset into the provided buffer. Returns an error if the buffer is not filled completely.
Source§

fn peek_cstring(&mut self) -> Result<CString, Error>

Peeks a C-style string (null-terminated) from the reader.
Source§

fn peek_cstring_at(&mut self, offset: u64) -> Result<CString, Error>

Peeks a C-style string (null-terminated) from the reader at a specific offset.
Source§

fn read_struct<S>(&mut self, big: bool, encoding: Encoding) -> Result<S, Error>
where S: StructUnpack,

Reads a struct from the reader. The struct must implement the StructUnpack trait. Read more
Source§

fn peek_at_vec(&mut self, offset: u64, len: usize) -> Result<Vec<u8>>

Peeks data from the reader at a specific offset into a vector. Returns the vector containing the data read.
Source§

fn peek_exact_at_vec(&mut self, offset: u64, len: usize) -> Result<Vec<u8>>

Peeks data from the reader at a specific offset into a vector. Returns an error if the buffer is not filled completely.
Source§

fn peek_u8(&mut self) -> Result<u8>

Peeks a u8 from the reader.
Source§

fn peek_u16(&mut self) -> Result<u16>

Peeks a u16 from the reader in little-endian order.
Source§

fn peek_u16_be(&mut self) -> Result<u16>

Peeks a u16 from the reader in big-endian order.
Source§

fn peek_u32(&mut self) -> Result<u32>

Peeks a u32 from the reader in little-endian order.
Source§

fn peek_u32_be(&mut self) -> Result<u32>

Peeks a u32 from the reader in big-endian order.
Source§

fn peek_u64(&mut self) -> Result<u64>

Peeks a u64 from the reader in little-endian order.
Source§

fn peek_u64_be(&mut self) -> Result<u64>

Peeks a u64 from the reader in big-endian order.
Source§

fn peek_u128(&mut self) -> Result<u128>

Peeks a u128 from the reader in little-endian order.
Source§

fn peek_u128_be(&mut self) -> Result<u128>

Peeks a u128 from the reader in big-endian order.
Source§

fn peek_i8(&mut self) -> Result<i8>

Peeks an i8 from the reader.
Source§

fn peek_i16(&mut self) -> Result<i16>

Peeks an i16 from the reader in little-endian order.
Source§

fn peek_i16_be(&mut self) -> Result<i16>

Peeks an i16 from the reader in big-endian order.
Source§

fn peek_i32(&mut self) -> Result<i32>

Peeks an i32 from the reader in little-endian order.
Source§

fn peek_i32_be(&mut self) -> Result<i32>

Peeks an i32 from the reader in big-endian order.
Source§

fn peek_i64(&mut self) -> Result<i64>

Peeks an i64 from the reader in little-endian order.
Source§

fn peek_i64_be(&mut self) -> Result<i64>

Peeks an i64 from the reader in big-endian order.
Source§

fn peek_i128(&mut self) -> Result<i128>

Peeks an i128 from the reader in little-endian order.
Source§

fn peek_i128_be(&mut self) -> Result<i128>

Peeks an i128 from the reader in big-endian order.
Source§

fn peek_u8_at(&mut self, offset: u64) -> Result<u8>

Peeks a u8 at a specific offset from the reader.
Source§

fn peek_u16_at(&mut self, offset: u64) -> Result<u16>

Peeks a u16 at a specific offset from the reader in little-endian order.
Source§

fn peek_u16_be_at(&mut self, offset: u64) -> Result<u16>

Peeks a u16 at a specific offset from the reader in big-endian order.
Source§

fn peek_u32_at(&mut self, offset: u64) -> Result<u32>

Peeks a u32 at a specific offset from the reader in little-endian order.
Source§

fn peek_u32_be_at(&mut self, offset: u64) -> Result<u32>

Peeks a u32 at a specific offset from the reader in big-endian order.
Source§

fn peek_u64_at(&mut self, offset: u64) -> Result<u64>

Peeks a u64 at a specific offset from the reader in little-endian order.
Source§

fn peek_u64_be_at(&mut self, offset: u64) -> Result<u64>

Peeks a u64 at a specific offset from the reader in big-endian order.
Source§

fn peek_u128_at(&mut self, offset: u64) -> Result<u128>

Peeks a u128 at a specific offset from the reader in little-endian order.
Source§

fn peek_u128_be_at(&mut self, offset: u64) -> Result<u128>

Peeks a u128 at a specific offset from the reader in big-endian order.
Source§

fn peek_i8_at(&mut self, offset: u64) -> Result<i8>

Peeks an i8 at a specific offset from the reader.
Source§

fn peek_i16_at(&mut self, offset: u64) -> Result<i16>

Peeks an i16 at a specific offset from the reader in little-endian order.
Source§

fn peek_i16_be_at(&mut self, offset: u64) -> Result<i16>

Peeks an i16 at a specific offset from the reader in big-endian order.
Source§

fn peek_i32_at(&mut self, offset: u64) -> Result<i32>

Peeks an i32 at a specific offset from the reader in little-endian order.
Source§

fn peek_i32_be_at(&mut self, offset: u64) -> Result<i32>

Peeks an i32 at a specific offset from the reader in big-endian order.
Source§

fn peek_i64_at(&mut self, offset: u64) -> Result<i64>

Peeks an i64 at a specific offset from the reader in little-endian order.
Source§

fn peek_i64_be_at(&mut self, offset: u64) -> Result<i64>

Peeks an i64 at a specific offset from the reader in big-endian order.
Source§

fn peek_i128_at(&mut self, offset: u64) -> Result<i128>

Peeks an i128 at a specific offset from the reader in little-endian order.
Source§

fn peek_i128_be_at(&mut self, offset: u64) -> Result<i128>

Peeks an i128 at a specific offset from the reader in big-endian order.
Source§

fn read_struct_vec<T: StructUnpack>( &mut self, count: usize, big: bool, encoding: Encoding, ) -> Result<Vec<T>>

Reads a vector of structs from the reader. The structs must implement the StructUnpack trait. Read more
Source§

fn peek_and_equal(&mut self, data: &[u8]) -> Result<()>

Peeks data and checks if it matches the provided data.
Source§

fn peek_and_equal_at(&mut self, offset: u64, data: &[u8]) -> Result<()>

Peeks data at a specific offset and checks if it matches the provided data.
Source§

impl<R> ReadBytesExt for R
where R: Read + ?Sized,

Source§

fn read_u8(&mut self) -> Result<u8, Error>

Reads an unsigned 8 bit integer from the underlying reader. Read more
Source§

fn read_i8(&mut self) -> Result<i8, Error>

Reads a signed 8 bit integer from the underlying reader. Read more
Source§

fn read_u16<T>(&mut self) -> Result<u16, Error>
where T: ByteOrder,

Reads an unsigned 16 bit integer from the underlying reader. Read more
Source§

fn read_i16<T>(&mut self) -> Result<i16, Error>
where T: ByteOrder,

Reads a signed 16 bit integer from the underlying reader. Read more
Source§

fn read_u24<T>(&mut self) -> Result<u32, Error>
where T: ByteOrder,

Reads an unsigned 24 bit integer from the underlying reader. Read more
Source§

fn read_i24<T>(&mut self) -> Result<i32, Error>
where T: ByteOrder,

Reads a signed 24 bit integer from the underlying reader. Read more
Source§

fn read_u32<T>(&mut self) -> Result<u32, Error>
where T: ByteOrder,

Reads an unsigned 32 bit integer from the underlying reader. Read more
Source§

fn read_i32<T>(&mut self) -> Result<i32, Error>
where T: ByteOrder,

Reads a signed 32 bit integer from the underlying reader. Read more
Source§

fn read_u48<T>(&mut self) -> Result<u64, Error>
where T: ByteOrder,

Reads an unsigned 48 bit integer from the underlying reader. Read more
Source§

fn read_i48<T>(&mut self) -> Result<i64, Error>
where T: ByteOrder,

Reads a signed 48 bit integer from the underlying reader. Read more
Source§

fn read_u64<T>(&mut self) -> Result<u64, Error>
where T: ByteOrder,

Reads an unsigned 64 bit integer from the underlying reader. Read more
Source§

fn read_i64<T>(&mut self) -> Result<i64, Error>
where T: ByteOrder,

Reads a signed 64 bit integer from the underlying reader. Read more
Source§

fn read_u128<T>(&mut self) -> Result<u128, Error>
where T: ByteOrder,

Reads an unsigned 128 bit integer from the underlying reader. Read more
Source§

fn read_i128<T>(&mut self) -> Result<i128, Error>
where T: ByteOrder,

Reads a signed 128 bit integer from the underlying reader. Read more
Source§

fn read_uint<T>(&mut self, nbytes: usize) -> Result<u64, Error>
where T: ByteOrder,

Reads an unsigned n-bytes integer from the underlying reader. Read more
Source§

fn read_int<T>(&mut self, nbytes: usize) -> Result<i64, Error>
where T: ByteOrder,

Reads a signed n-bytes integer from the underlying reader. Read more
Source§

fn read_uint128<T>(&mut self, nbytes: usize) -> Result<u128, Error>
where T: ByteOrder,

Reads an unsigned n-bytes integer from the underlying reader.
Source§

fn read_int128<T>(&mut self, nbytes: usize) -> Result<i128, Error>
where T: ByteOrder,

Reads a signed n-bytes integer from the underlying reader.
Source§

fn read_f32<T>(&mut self) -> Result<f32, Error>
where T: ByteOrder,

Reads a IEEE754 single-precision (4 bytes) floating point number from the underlying reader. Read more
Source§

fn read_f64<T>(&mut self) -> Result<f64, Error>
where T: ByteOrder,

Reads a IEEE754 double-precision (8 bytes) floating point number from the underlying reader. Read more
Source§

fn read_u16_into<T>(&mut self, dst: &mut [u16]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of unsigned 16 bit integers from the underlying reader. Read more
Source§

fn read_u32_into<T>(&mut self, dst: &mut [u32]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of unsigned 32 bit integers from the underlying reader. Read more
Source§

fn read_u64_into<T>(&mut self, dst: &mut [u64]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of unsigned 64 bit integers from the underlying reader. Read more
Source§

fn read_u128_into<T>(&mut self, dst: &mut [u128]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of unsigned 128 bit integers from the underlying reader. Read more
Source§

fn read_i8_into(&mut self, dst: &mut [i8]) -> Result<(), Error>

Reads a sequence of signed 8 bit integers from the underlying reader. Read more
Source§

fn read_i16_into<T>(&mut self, dst: &mut [i16]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of signed 16 bit integers from the underlying reader. Read more
Source§

fn read_i32_into<T>(&mut self, dst: &mut [i32]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of signed 32 bit integers from the underlying reader. Read more
Source§

fn read_i64_into<T>(&mut self, dst: &mut [i64]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of signed 64 bit integers from the underlying reader. Read more
Source§

fn read_i128_into<T>(&mut self, dst: &mut [i128]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of signed 128 bit integers from the underlying reader. Read more
Source§

fn read_f32_into<T>(&mut self, dst: &mut [f32]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of IEEE754 single-precision (4 bytes) floating point numbers from the underlying reader. Read more
Source§

fn read_f32_into_unchecked<T>(&mut self, dst: &mut [f32]) -> Result<(), Error>
where T: ByteOrder,

👎Deprecated since 1.2.0: please use read_f32_into instead
DEPRECATED. Read more
Source§

fn read_f64_into<T>(&mut self, dst: &mut [f64]) -> Result<(), Error>
where T: ByteOrder,

Reads a sequence of IEEE754 double-precision (8 bytes) floating point numbers from the underlying reader. Read more
Source§

fn read_f64_into_unchecked<T>(&mut self, dst: &mut [f64]) -> Result<(), Error>
where T: ByteOrder,

👎Deprecated since 1.2.0: please use read_f64_into instead
DEPRECATED. Read more
Source§

impl<T> ReadExt for T
where T: Read,

Source§

fn read_u8(&mut self) -> Result<u8, Error>

Reads a u8 from the reader.
Source§

fn read_u16(&mut self) -> Result<u16, Error>

Reads a u16 from the reader in little-endian order.
Source§

fn read_u16_be(&mut self) -> Result<u16, Error>

Reads a u16 from the reader in big-endian order.
Source§

fn read_u32(&mut self) -> Result<u32, Error>

Reads a u32 from the reader in little-endian order.
Source§

fn read_u32_be(&mut self) -> Result<u32, Error>

Reads a u32 from the reader in big-endian order.
Source§

fn read_u64(&mut self) -> Result<u64, Error>

Reads a u64 from the reader in little-endian order.
Source§

fn read_u64_be(&mut self) -> Result<u64, Error>

Reads a u64 from the reader in big-endian order.
Source§

fn read_u128(&mut self) -> Result<u128, Error>

Reads a u128 from the reader in little-endian order.
Source§

fn read_u128_be(&mut self) -> Result<u128, Error>

Reads a u128 from the reader in big-endian order.
Source§

fn read_i8(&mut self) -> Result<i8, Error>

Reads an i8 from the reader.
Source§

fn read_i16(&mut self) -> Result<i16, Error>

Reads an i16 from the reader in little-endian order.
Source§

fn read_i16_be(&mut self) -> Result<i16, Error>

Reads an i16 from the reader in big-endian order.
Source§

fn read_i32(&mut self) -> Result<i32, Error>

Reads an i32 from the reader in little-endian order.
Source§

fn read_i32_be(&mut self) -> Result<i32, Error>

Reads an i32 from the reader in big-endian order.
Source§

fn read_i64(&mut self) -> Result<i64, Error>

Reads an i64 from the reader in little-endian order.
Source§

fn read_i64_be(&mut self) -> Result<i64, Error>

Reads an i64 from the reader in big-endian order.
Source§

fn read_i128(&mut self) -> Result<i128, Error>

Reads an i128 from the reader in little-endian order.
Source§

fn read_i128_be(&mut self) -> Result<i128, Error>

Reads an i128 from the reader in big-endian order.
Source§

fn read_f32(&mut self) -> Result<f32, Error>

Reads a f32 from the reader in little-endian order.
Source§

fn read_f32_be(&mut self) -> Result<f32, Error>

Reads a f32 from the reader in big-endian order.
Source§

fn read_f64(&mut self) -> Result<f64, Error>

Reads a f64 from the reader in little-endian order.
Source§

fn read_f64_be(&mut self) -> Result<f64, Error>

Reads a f64 from the reader in big-endian order.
Source§

fn read_cstring(&mut self) -> Result<CString, Error>

Reads a C-style string (null-terminated) from the reader.
Source§

fn read_fstring( &mut self, len: usize, encoding: Encoding, trim: bool, ) -> Result<String, Error>

Reads a C-style string (null-terminated) from the reader with maximum length. Read more
Source§

fn read_exact_vec(&mut self, len: usize) -> Result<Vec<u8>, Error>

Reads some data from the reader into a vector.
Source§

fn read_and_equal(&mut self, data: &[u8]) -> Result<(), Error>

Reads data and checks if it matches the provided data.
Source§

impl<T> ReadExt for T
where T: Read,

Source§

fn read_to_tendril<A>( &mut self, buf: &mut Tendril<Bytes, A>, ) -> Result<usize, Error>
where A: Atomicity,

Read all bytes until EOF.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SeekExt for T
where T: Seek,

Source§

fn stream_length(&mut self) -> Result<u64, Error>

Returns the length of the stream.
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> ErasedDestructor for T
where T: 'static,