Tipos do tyrus:archive
Tipos precisam ser importados pelo nome
ArchiveEntry, ArchiveEntryKind, ArchiveError, ArchiveFormat, ArchiveSummary, PackOptions e UnpackOptions precisam ser importados explicitamente sempre que seus campos, membros ou literais de objeto forem usados.
ArchiveSummary
ArchiveSummary é retornado por pack e unpack.
| Campo | Tipo | Descrição |
|---|---|---|
entries | u64 | Arquivos e diretórios gravados. |
bytes | u64 | Bytes de arquivo descomprimidos gravados. |
ArchiveEntry
ArchiveEntry é retornado por list.
| Campo | Tipo | Descrição |
|---|---|---|
name | string | O nome da entrada exatamente como o arquivo o guarda. Nomes de diretório terminam com / em arquivos ZIP. |
kind | ArchiveEntryKind | O que a entrada é. |
size | u64 | Tamanho descomprimido em bytes. |
compressedSize | u64? | Tamanho comprimido em bytes para entradas ZIP; ausente para entradas TAR. |
ArchiveEntryKind
| Membro | Significado |
|---|---|
File | Um arquivo regular. |
Directory | Um diretório. |
Symlink | Um link simbólico. O unpack o recusa. |
HardLink | Um link físico. O unpack o recusa. |
Other | Um dispositivo, pipe ou outra entrada especial. O unpack a recusa. |
tyrus
import { ArchiveEntry, ArchiveEntryKind, ArchiveError, list } from "tyrus:archive";
async function hasLinks(): Promise<Result<boolean, ArchiveError>> {
const entries: ArchiveEntry[] = await list("./upload.tar")?;
return Ok(entries.some((entry: ArchiveEntry): boolean => entry.kind === ArchiveEntryKind.Symlink));
}ArchiveFormat
O formato que packStream escreve, já que uma stream não tem extensão para decidi-lo.
| Membro | Formato |
|---|---|
Zip | ZIP, com data descriptors. |
Tar | TAR, sem compressão. |
TarGz | TAR comprimido com Gzip. |
PackOptions
| Campo | Tipo | Padrão |
|---|---|---|
level | i32? | 6 |
overwrite | boolean? | false |
exclude | string[]? | nenhum |
prefix | string? | nenhum |
reproducible | boolean? | false |
timeoutMs | u64? | 600000 |
Veja em pack o que cada opção faz.
UnpackOptions
| Campo | Tipo | Padrão |
|---|---|---|
overwrite | boolean? | false |
stripComponents | u32? | 0 |
maxEntries | u64? | 100000 |
maxBytes | u64? | 4 GiB |
maxRatio | u32? | 200 |
timeoutMs | u64? | 600000 |
Veja em unpack o que cada opção faz.
ArchiveError
ArchiveError é o erro recuperável de toda operação de arquivo, entregue como o Err do Result com que cada função resolve.
| Campo | Tipo | Descrição |
|---|---|---|
code | string | Identificador estável, como ERR_ARCHIVE_PATH_ESCAPE. Veja os códigos de erro. |
message | string | Descrição legível. |
entry | string? | A entrada do arquivo ou o caminho de origem que causou a falha, quando houver, truncado em 4 KiB. |
tyrus
import { ArchiveError, ArchiveSummary, unpack } from "tyrus:archive";
async function extract(): Promise<void> {
const result: Result<ArchiveSummary, ArchiveError> = await unpack("./upload.zip", "./out");
match (result) {
Ok(summary) => { print(summary.entries); }
Err(error) => {
printError(error.code); // ERR_ARCHIVE_UNSAFE_LINK
printError(error.entry ?? ""); // docs/latest
}
}
}