Struct Ark 

pub struct Ark<C>(/* private fields */);

Representation of an Archive.

Because this is generic, it can represent things like a directory on disk, allowing us to convert an Ark of on-disk files into an Ark of imported files in a simple, high-performance way. It obviates the need for things like a stream API, and allows for a lot of tests to be done in-memory without disk.

The underlying format is an SOA approach, which you can inspect with:

• ark.paths()
• ark.attrs()
• ark.contents()

These three channels are implemented as immutable, reference-counted vectors. This is great for memory hygiene! Almost every possible transformation you’d ever want to do on an Ark will leave one or two channels unchanged, and create a new vector for the stuff that is changing.

Implementations

impl<C> Ark<C>

pub fn from_entries<E>(entries: impl IntoIterator<Item = E>) -> Self

where E: Into<Entry<C>>,

Read entries into Ark format.

pub fn to_entries(self) -> Vec<(IPR, Attrs, Contents<C>)>

where Vec<C>: Clone,

Turn this Ark into a Vec of entries.

impl<C> Ark<C>

where C: Temporizable,

pub fn import_files(self, db: &DB) -> Result<Ark<Digest>>

Import files into an on-disk database.

pub fn import(self, db: &DB) -> Result<Digest>

Import files and serialized self into DB.

impl Ark<PathBuf>

pub fn read(self) -> Result<Ark<Vec<u8>>>

Fetch file contents from disk into memory.

Be warned that this may be a very bad idea if the directory is larger than you have RAM for.

impl Ark<PathBuf>

pub fn scan(base: impl AsRef<Path>) -> Result<Self>

Fetch metadata for a directory into memory.

This isn’t a parallel process, but it’s fast, and allows subsequent steps to load in a high-performance parallel way.

Examples found in repository

examples/copy_source.rs (line 5)

fn main() -> Result<()> {
    Ark::scan("./src")?.write("./copy_of_src")?;
    Ok(())
}

impl<C> Ark<C>

pub fn from_translation<SRC>(src: Ark<SRC>) -> Self

where C: From<SRC>, SRC: Clone,

Easy conversion by content type.

impl Ark<PathBuf>

pub fn write(&self, dest: impl AsRef<Path>) -> Result<()>

Write files to a directory.

TODO: Permissions

Examples found in repository

examples/copy_source.rs (line 5)

fn main() -> Result<()> {
    Ark::scan("./src")?.write("./copy_of_src")?;
    Ok(())
}

impl<C> Ark<C>

pub fn paths(&self) -> &Vec<IPR>

Internal paths list.

In an archive of length F+D, the following is guaranteed:

• This vector is length F+D.
• There are no duplicate paths.
• All files come before all directories.
• Within each of those sections, paths are sorted.

pub fn attrs(&self) -> &Vec<Attrs>

Internal attrs list.

In an archive of length F+D, the following is guaranteed:

• This vector is length F+D.
• ark.attrs()[N] corresponds to ark.paths()[N].

pub fn contents(&self) -> &Vec<C>

Internal contents list.

In an archive of length F+D, the following is guaranteed:

• This vector is length F, not F+D.
• ark.contents()[N] corresponds to ark.paths()[N].

pub fn len(&self) -> usize

Number of entries in this Ark.

pub fn files<'a>(&'a self) -> FileIterator<'a, C>

Iterate the files in an Archive

pub fn dirs<'a>(&'a self) -> DirIterator<'a, C>

Iterate the dirs in an Archive

pub fn compose( paths: Rc<Vec<IPR>>, attrs: Rc<Vec<Attrs>>, contents: Rc<Vec<C>>, ) -> Self

Slap together a new Ark from the constituent pieces.

Panics if length invariants aren’t fulfilled.

pub fn decompose(self) -> (Rc<Vec<IPR>>, Rc<Vec<Attrs>>, Rc<Vec<C>>)

Break an Ark into its constituent components, moving them.

This is designed to pair with compose to allow you to reuse backing memory while doing transformations. Usually you’ll only care about transforming one, maybe two of the three channels.

pub fn empty() -> Self

Create an empty Ark.

Not as widely useful as you’d think, since Ark is efficient for bulk operations, and not a great type for incremental mutability. Usually you’ll want to work with a list of (path, attrs, Contents<C>) tuples for poking around in little bits and pieces. These convert back and forth with Arks very easily.

Trait Implementations

impl<C: Clone> Clone for Ark<C>

fn clone(&self) -> Ark<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for Ark<C>

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

Formats the value using the given formatter.

impl<'de, C> Deserialize<'de> for Ark<C>

where C: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Ark<&str>> for Ark<String>

fn from(src: Ark<&str>) -> Self

Converts to this type from the input type.

impl From<Ark<&str>> for Ark<Vec<u8>>

fn from(src: Ark<&str>) -> Self

Converts to this type from the input type.

impl<C> From<Ark<C>> for Vec<(IPR, Attrs, Contents<C>)>

where Vec<C>: Clone,

fn from(src: Ark<C>) -> Self

Converts to this type from the input type.

impl From<Ark<String>> for Ark<Vec<u8>>

fn from(src: Ark<String>) -> Self

Converts to this type from the input type.

impl<C, S> From<Vec<(S, Attrs, Contents<C>)>> for Ark<C>

where S: Into<IPR>,

fn from(src: Vec<(S, Attrs, Contents<C>)>) -> Self

Converts to this type from the input type.

impl<C, S> From<Vec<(S, Contents<C>)>> for Ark<C>

where S: Into<IPR>,

fn from(src: Vec<(S, Contents<C>)>) -> Self

Converts to this type from the input type.

impl<C: PartialEq> PartialEq for Ark<C>

fn eq(&self, other: &Ark<C>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<C> Save for Ark<C>

where Ark<C>: ToJson,

fn save(&self, db: &DB) -> Result<Digest>

impl<C> Serialize for Ark<C>

where C: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<C> ToJson for Ark<C>

where Ark<C>: Serialize,

fn to_json(&self) -> Result<String>

impl<C> StructuralPartialEq for Ark<C>