Struct Encoder 

pub struct Encoder<FS: FileSystem = NativeFileSystem> { /* private fields */ }

Encoder which can archive a given path as a NAR file.

The encoder will read the data to archive using its FileSystem implementation. By default, it reads the host filesystem using std::fs.

Implementations

impl Encoder<NativeFileSystem>

pub fn new<P: AsRef<Path>>(path: P) -> Result<Self, NarError>

Create a new encoder for file hierarchy at the given path using default filesystem implementation.

Errors

Returns an error if the path is not valid UTF-8.

pub fn builder<P: AsRef<Path>>(path: P) -> EncoderBuilder<P>

Create a builder for this encoder that can take additional options.

use nix_nar::{Encoder, NativeFileSystem};
let mut enc = Encoder::builder("./test-data/")
    .internal_buffer_size(2048)
    .filesystem(NativeFileSystem {})
    .build().unwrap();
let mut nar = File::create("output2.nar")?;
io::copy(&mut enc, &mut nar)?;

impl<FS: FileSystem> Encoder<FS>

pub fn new_with_filesystem<P: AsRef<Path>>( path: P, fs: FS, ) -> Result<Self, NarError>

Create a new encoder for file hierarchy at the given path and provided filesystem implementation.

Errors

Returns an error if the path is not valid UTF-8.

pub fn pack<P: AsRef<Path>>(&mut self, dst: P) -> Result<(), NarError>

Archive to the given path.

This is equivalent to creating the file, and io::copying to it.

Errors

Returns an error if the path already exists or an I/O error occurs.

Trait Implementations

impl<FS: FileSystem> Read for Encoder<FS>

Read the encoded NAR file.

Errors

Self::read will return underlying I/O errors returned by FileSystem.

It will also return an error if the data read from an archived file is not the same length as declared by FileSystem::metadata. The length from the metadata was already written to the NAR output at this point, so it’s not possible to recover and produce a valid archive.

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.

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

Like read, except that it reads into a slice of buffers.

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.

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.

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

Reads all bytes until EOF in this source, appending them to buf.

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

Reads the exact number of bytes required to fill buf.

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

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

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

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

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

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

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

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

🔬This is a nightly-only experimental API. (read_array)

Read and return a fixed array of bytes from this source.

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

where T: FromEndianBytes, Self: Sized,

🔬This is a nightly-only experimental API. (read_le)

Read and return a type (e.g. an integer) in little-endian order.

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

where T: FromEndianBytes, Self: Sized,

🔬This is a nightly-only experimental API. (read_le)

Read and return a type (e.g. an integer) in big-endian order.