Struct File

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

Represents a file within the FO4 virtual filesystem.

Fields

header: Header

Implementations

impl<'bytes> File<'bytes>

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

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

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

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

pub fn clear(&mut self)

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.

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

Panics

Panics if index exceeds len, or is_full.

pub fn is_empty(&self) -> bool

pub fn is_full(&self) -> bool

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

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

pub fn len(&self) -> usize

pub fn new() -> Self

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

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

Panics

Panics if is_full.

pub fn remaining_capacity(&self) -> usize

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

Panics

Panics if index exceeds len.

pub fn retain_mut<F>(&mut self, f: F)

where F: FnMut(&mut Chunk<'bytes>) -> bool,

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

Panics

Panics if index exceeds len, or is_empty.

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

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

Panics

Panics if index exceeds len.

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

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

Panics

Panics if index exceeds len.

pub fn write<Out>(&self, stream: &mut Out, options: &WriteOptions) -> Result<()>

where Out: ?Sized + Write,

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> File<'bytes>

Returns the “default value” for a type.

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

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = Chunk<'bytes>>,

Creates a value from an iterator.

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

type Output = Chunk<'bytes>

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for File<'_>

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

Performs the mutable indexing (container[index]) operation.

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?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

type Error = Error

type Options = ReadOptions

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

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

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

type Error = Error

type Options = ReadOptions

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

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

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

type Error = Error

type Options = ReadOptions

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

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

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

type Error = Error

type Options = ReadOptions

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

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