Struct AsyncReader

Source

pub struct AsyncReader<T>where
    T: AsyncReadAt + AsyncGetSize + Unpin,
{ /* private fields */ }

Expand description

A struct to open and read a FAR-formatted archive asynchronously.

Implementations§

Source §

impl<T> AsyncReader<T>
where T: AsyncReadAt + AsyncGetSize + Unpin,

Source

pub async fn new(source: T) -> Result<Self, Error>

Create a new AsyncReader for the provided source.

Source

pub fn list(&self) -> impl ExactSizeIterator<Item = Entry<'_>>

Return a list of the items in the archive

Source

pub async fn read_file(&mut self, path: &[u8]) -> Result<Vec<u8>, Error>

Read the entire contents of the entry with the specified path. O(log(# directory entries))

Source

pub fn get_size(&mut self, path: &[u8]) -> Result<u64, Error>

Get the size in bytes of the entry with the specified path. O(log(# directory entries))

Trait Implementations§

Source §

impl<T> Debug for AsyncReader<T>
where T: AsyncReadAt + AsyncGetSize + Unpin + Debug,

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> UnwindSafe for AsyncReader<T>
where T: UnwindSafe,

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, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

Source §

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more

Source §

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

Source §

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into 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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.

§

type Init = T

The type for initializers.

§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

Source §

impl<T, U> TryFrom 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>::Error>

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

Struct AsyncReaderCopy item path

Implementations§

impl<T> AsyncReader<T>where T: AsyncReadAt + AsyncGetSize + Unpin,

pub async fn new(source: T) -> Result<Self, Error>

pub fn list(&self) -> impl ExactSizeIterator<Item = Entry<'_>>

pub async fn read_file(&mut self, path: &[u8]) -> Result<Vec<u8>, Error>

pub fn get_size(&mut self, path: &[u8]) -> Result<u64, Error>

Trait Implementations§

impl<T> Debug for AsyncReader<T>where T: AsyncReadAt + AsyncGetSize + Unpin + Debug,

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

Auto Trait Implementations§

impl<T> Freeze for AsyncReader<T>where T: Freeze,

impl<T> RefUnwindSafe for AsyncReader<T>where T: RefUnwindSafe,

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

impl<T> Sync for AsyncReader<T>where T: Sync,

impl<T> Unpin for AsyncReader<T>

impl<T> UnwindSafe for AsyncReader<T>where T: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T, D> Encode<Ambiguous1, D> for Twhere D: ResourceDialect,

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

impl<T, D> Encode<Ambiguous2, D> for Twhere D: ResourceDialect,

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = _

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

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

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

Struct AsyncReader

impl<T> AsyncReader<T>
where T: AsyncReadAt + AsyncGetSize + Unpin,

impl<T> Debug for AsyncReader<T>
where T: AsyncReadAt + AsyncGetSize + Unpin + Debug,

impl<T> Freeze for AsyncReader<T>
where T: Freeze,

impl<T> RefUnwindSafe for AsyncReader<T>
where T: RefUnwindSafe,

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

impl<T> Sync for AsyncReader<T>
where T: Sync,

impl<T> UnwindSafe for AsyncReader<T>
where T: UnwindSafe,

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

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

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

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

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

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,