Struct nix_compat::nar::writer::sync::Node

pub struct Node<'a, W: Write> {
    writer: &'a mut W,
}

Single node in a NAR file.

A NAR can be thought of as a tree of nodes represented by this type. Each node can be a file, a symlink or a directory containing other nodes.

Fields

writer: &'a mut W

Implementations

impl<'a, W: Write> Node<'a, W>

fn write(&mut self, data: &[u8]) -> Result<()>

fn pad(&mut self, n: u64) -> Result<()>

pub fn symlink(self, target: &[u8]) -> Result<()>

Make this node a symlink.

pub fn file( self, executable: bool, size: u64, reader: &mut dyn BufRead, ) -> Result<()>

Make this node a single file.

pub fn file_manual_write( self, executable: bool, size: u64, ) -> Result<(&'a mut W, FileManualWrite)>

Make this node a single file but let the user handle the writing of the file contents. The user gets access to a writer to write the file contents to, plus a struct they must invoke a function on to finish writing the NAR file.

It is the caller’s responsibility to write the correct number of bytes to the writer and invoke FileManualWrite::close, or invalid archives will be produced silently.

let contents = "Hello world\n".as_bytes();
let size = contents.len() as u64;
let executable = false;

let (writer, skip) = nar
    .file_manual_write(executable, size)?;

// Write the contents
writer.write_all(&contents)?;

// Close the file node
skip.close(writer)?;

pub fn directory(self) -> Result<Directory<'a, W>>

Make this node a directory, the content of which is set using the resulting Directory value.

It is the caller’s responsibility to invoke Directory::close, or invalid archives will be produced silently.