ArchiveEncoder

[Source]

class ref ArchiveEncoder

Constructors

create

[Source]

Creates a new corral archive with no entries

root is filesystem path root for all archive entries. If root is set to /home/pony then when adding an entry: /home/pony/corral.json

new ref create(
  root: FilePath val,
  version: U8 val = 1)
: ArchiveEncoder ref^ ?

Parameters

• root: FilePath val
• version: U8 val = 1

Returns

• ArchiveEncoder ref^ ?

---

Public Functions

add

[Source]

Adds the contents of from to the Corral archive file to.

• Directories are recursively added.
• Symlinks are ignored

fun ref add(
  from: FilePath val)
: None val ?

Parameters

• from: FilePath val

Returns

• None val ?

---

write

[Source]

Creates a new archive file at to. Throws an error if it is unable to create the archive.

• Removes any existing file at to
• Resets the archiver after writing

fun ref write(
  to: FilePath val)
: None val ?

Parameters

• to: FilePath val

Returns

• None val ?

---