Struct ba2::tes4::File

pub struct File<'bytes> { /* private fields */ }

Represents a file within the TES4 virtual filesystem.

Implementations

impl<'bytes> File<'bytes>

pub fn as_bytes(&self) -> &[u8]

pub fn as_ptr(&self) -> *const u8

pub fn into_owned(self) -> File<'static>

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn new() -> Self

impl<'bytes> File<'bytes>

pub fn compress(&self, options: &CompressionOptions) -> Result<File<'static>>

pub fn decompress(&self, options: &CompressionOptions) -> Result<File<'static>>

pub fn decompressed_len(&self) -> Option<usize>

pub fn is_compressed(&self) -> bool

pub fn is_decompressed(&self) -> bool

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

where Out: ?Sized + Write,

impl<'bytes> File<'bytes>

pub fn compress_into( &self, out: &mut Vec<u8>, options: &CompressionOptions ) -> Result<()>

pub fn decompress_into( &self, out: &mut Vec<u8>, options: &CompressionOptions ) -> Result<()>

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> CompressableFrom<&'bytes [u8]> for File<'bytes>

fn from_compressed(value: &'bytes [u8], decompressed_len: usize) -> Self

Makes a compressed instance of Self using the given data.

fn from_decompressed(value: &'bytes [u8]) -> Self

Makes a decompressed instance of Self using the given data.

impl<'bytes, const N: usize> CompressableFrom<&'bytes [u8; N]> for File<'bytes>

fn from_compressed(value: &'bytes [u8; N], decompressed_len: usize) -> Self

Makes a compressed instance of Self using the given data.

fn from_decompressed(value: &'bytes [u8; N]) -> Self

Makes a decompressed instance of Self using the given data.

impl CompressableFrom<Box<[u8]>> for File<'static>

fn from_compressed(value: Box<[u8]>, decompressed_len: usize) -> Self

Makes a compressed instance of Self using the given data.

fn from_decompressed(value: Box<[u8]>) -> Self

Makes a decompressed instance of Self using the given data.

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 ReaderWithOptions<&File> for File<'static>

type Error = Error

type Item = File<'static>

type Options = ReadOptions

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

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

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

type Error = Error

type Item = File<'static>

type Options = ReadOptions

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

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 Item = File<'bytes>

type Options = ReadOptions

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.

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

type Error = Error

type Item = File<'static>

type Options = ReadOptions

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.