Struct nuts_archive::Archive

pub struct Archive<B: Backend> { /* private fields */ }

The archive.

Implementations

impl<B: Backend> Archive<B>

pub fn create( container: Container<B>, force: bool, ) -> ArchiveResult<Archive<B>, B>

Creates a new archive in container.

General initial information about the archive is stored in the user data of the container. This means the archive can be easily opened again the next time it is loaded. This means that no user data is currently allowed to be stored in the container, otherwise it could be overwritten. Existing user data can be overwritten if the force flag is set to true.

Errors

If user data of the container could be overwritten, an Error::OverwriteUserdata error will be returned.

pub fn open(container: Container<B>) -> ArchiveResult<Archive<B>, B>

Opens an archive from container.

The initial information about the archive is loaded from the user data of the container.

Errors

If no user data is stored in the container, an Error::InvalidUserdata(None) error is returned; if it does not contain valid archive information, an Error::InvalidUserdata(Some(...)) error is returned.

pub fn info(&self) -> Info

Fetches statistics/information from the archive.

pub fn first(&mut self) -> Option<ArchiveResult<Entry<'_, B>, B>>

Returns the first entry in the archive.

Next, you can use Entry::next() to traverse through the archive.

If the archive is empty, None is returned.

pub fn lookup<N: AsRef<str>>( &mut self, name: N, ) -> Option<ArchiveResult<Entry<'_, B>, B>>

Searches for an entry with the given name.

It scans the whole archive and returns the first entry which has the given name wrapped into a Some. If no such entry exists, None is returned.

pub fn append_file<N: AsRef<str>>(&mut self, name: N) -> FileBuilder<'_, B>

Appends a new file entry with the given name at the end of the archive.

The method returns a FileBuilder instance, where you are able to set some more properties for the new entry. Calling FileBuilder::build() will finally create the entry.

pub fn append_directory<N: AsRef<str>>( &mut self, name: N, ) -> DirectoryBuilder<'_, B>

Appends a new directory entry with the given name at the end of the archive.

The method returns a DirectoryBuilder instance, where you are able to set some more properties for the new entry. Calling DirectoryBuilder::build() will finally create the entry.

pub fn append_symlink<N: AsRef<str>, T: AsRef<str>>( &mut self, name: N, target: T, ) -> SymlinkBuilder<'_, B>

Appends a new symlink entry with the given name at the end of the archive.

The symlink points to the given target name.

The method returns a SymlinkBuilder instance, where you are able to set some more properties for the new entry. Calling SymlinkBuilder::build() will finally create the entry.

pub fn into_container(self) -> Container<B>

Consumes this Archive, returning the underlying Container.

Trait Implementations

impl<B: Backend> AsRef<Container<B>> for Archive<B>

fn as_ref(&self) -> &Container<B>

Converts this type into a shared reference of the (usually inferred) input type.