Struct ba2::fo4::File

source ·
pub struct File<'bytes> {
    pub header: Header,
    /* private fields */
}
Expand description

Represents a file within the FO4 virtual filesystem.

Fields§

§header: Header

Implementations§

source§

impl<'bytes> File<'bytes>

source

pub fn as_mut_ptr(&mut self) -> *mut Chunk<'bytes>

source

pub fn as_mut_slice(&mut self) -> &mut [Chunk<'bytes>]

source

pub fn as_ptr(&self) -> *const Chunk<'bytes>

source

pub fn as_slice(&self) -> &[Chunk<'bytes>]

source

pub fn clear(&mut self)

source

pub fn drain<R>(&mut self, range: R) -> impl Iterator<Item = Chunk<'bytes>> + '_
where R: RangeBounds<usize>,

§Panics

Panics if start_bound exceeds end_bound, or if end_bound exceeds len.

source

pub fn insert(&mut self, index: usize, element: Chunk<'bytes>)

§Panics

Panics if index exceeds len, or is_full.

source

pub fn is_empty(&self) -> bool

source

pub fn is_full(&self) -> bool

source

pub fn iter(&self) -> impl Iterator<Item = &Chunk<'bytes>>

source

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut Chunk<'bytes>>

source

pub fn len(&self) -> usize

source

pub fn new() -> Self

source

pub fn pop(&mut self) -> Option<Chunk<'bytes>>

source

pub fn push(&mut self, element: Chunk<'bytes>)

§Panics

Panics if is_full.

source

pub fn remaining_capacity(&self) -> usize

source

pub fn remove(&mut self, index: usize) -> Chunk<'bytes>

§Panics

Panics if index exceeds len.

source

pub fn retain_mut<F>(&mut self, f: F)
where F: FnMut(&mut Chunk<'bytes>) -> bool,

source

pub fn swap_remove(&mut self, index: usize) -> Chunk<'bytes>

§Panics

Panics if index exceeds len, or is_empty.

source

pub fn truncate(&mut self, len: usize)

source

pub fn try_insert( &mut self, index: usize, element: Chunk<'bytes> ) -> Result<(), CapacityError<'bytes>>

§Panics

Panics if index exceeds len.

source

pub fn try_push( &mut self, element: Chunk<'bytes> ) -> Result<(), CapacityError<'bytes>>

source

pub fn try_swap_remove(&mut self, index: usize) -> Option<Chunk<'bytes>>

§Panics

Panics if index exceeds len.

source

pub fn write<Out>(&self, stream: &mut Out, options: &WriteOptions) -> Result<()>
where Out: ?Sized + Write,

Trait Implementations§

source§

impl<'bytes> Clone for File<'bytes>

source§

fn clone(&self) -> File<'bytes>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<'bytes> Debug for File<'bytes>

source§

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

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

impl<'bytes> Default for File<'bytes>

source§

fn default() -> File<'bytes>

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

impl<'bytes> FromIterator<Chunk<'bytes>> for File<'bytes>

source§

fn from_iter<T>(iter: T) -> Self
where T: IntoIterator<Item = Chunk<'bytes>>,

Creates a value from an iterator. Read more
source§

impl<'bytes> Index<usize> for File<'bytes>

§

type Output = Chunk<'bytes>

The returned type after indexing.
source§

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation. Read more
source§

impl<'bytes> IndexMut<usize> for File<'bytes>

source§

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation. Read more
source§

impl<'bytes, 'this> IntoIterator for &'this File<'bytes>

§

type Item = <&'this Vec<Chunk<'bytes>> as IntoIterator>::Item

The type of the elements being iterated over.
§

type IntoIter = <&'this Vec<Chunk<'bytes>> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<'bytes, 'this> IntoIterator for &'this mut File<'bytes>

§

type Item = <&'this mut Vec<Chunk<'bytes>> as IntoIterator>::Item

The type of the elements being iterated over.
§

type IntoIter = <&'this mut Vec<Chunk<'bytes>> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<'bytes> IntoIterator for File<'bytes>

§

type Item = <Vec<Chunk<'bytes>> as IntoIterator>::Item

The type of the elements being iterated over.
§

type IntoIter = <Vec<Chunk<'bytes>> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl ReaderWithOptions<&File> for File<'static>

§

type Error = Error

§

type Item = File<'static>

§

type Options = ReadOptions

source§

fn read(source: &File, options: &Self::Options) -> Result<Self::Item>

Reads an instance of Self::Item from the given source, using the given options.
source§

impl ReaderWithOptions<&Path> for File<'static>

§

type Error = Error

§

type Item = File<'static>

§

type Options = ReadOptions

source§

fn read(source: &Path, options: &Self::Options) -> Result<Self::Item>

Reads an instance of Self::Item from the given source, using the given options.
source§

impl<'bytes> ReaderWithOptions<Borrowed<'bytes>> for File<'bytes>

§

type Error = Error

§

type Item = File<'bytes>

§

type Options = ReadOptions

source§

fn read(source: Borrowed<'bytes>, options: &Self::Options) -> Result<Self::Item>

Reads an instance of Self::Item from the given source, using the given options.
source§

impl<'bytes> ReaderWithOptions<Copied<'bytes>> for File<'static>

§

type Error = Error

§

type Item = File<'static>

§

type Options = ReadOptions

source§

fn read(source: Copied<'bytes>, options: &Self::Options) -> Result<Self::Item>

Reads an instance of Self::Item from the given source, using the given options.

Auto Trait Implementations§

§

impl<'bytes> RefUnwindSafe for File<'bytes>

§

impl<'bytes> Send for File<'bytes>

§

impl<'bytes> Sync for File<'bytes>

§

impl<'bytes> Unpin for File<'bytes>

§

impl<'bytes> UnwindSafe for File<'bytes>

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> ToOwned for T
where T: Clone,

§

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>,

§

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>,

§

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.