licence_audit/source_archive

Types

ArchiveError

pub type ArchiveError {
  InvalidArchive
  MissingContentsArchive
  MissingRootFile
  InvalidText(path: String)
}

Constructors

```
InvalidArchive
```
```
MissingContentsArchive
```
```
MissingRootFile
```
```
InvalidText(path: String)
```

ArchiveFile

</>

pub type ArchiveFile {
  ArchiveFile(path: String, contents: BitArray)
}

Constructors

ArchiveFile(path: String, contents: BitArray)

Values

describe_error

</>

pub fn describe_error(error: ArchiveError) -> String

extract_hex_contents

</>

pub fn extract_hex_contents(
  data: BitArray,
) -> Result(List(ArchiveFile), ArchiveError)

extract_hex_contents_selected

</>

pub fn extract_hex_contents_selected(
  data: BitArray,
  select: fn(List(String)) -> List(#(String, String)),
) -> Result(List(ArchiveFile), ArchiveError)

extract_package_file_tar_gz

</>

pub fn extract_package_file_tar_gz(
  data: BitArray,
  directory: String,
  filename: String,
) -> Result(BitArray, ArchiveError)

extract_root_file_tar_gz

</>

pub fn extract_root_file_tar_gz(
  data: BitArray,
  filename: String,
) -> Result(BitArray, ArchiveError)

extract_tar

</>

pub fn extract_tar(
  data: BitArray,
) -> Result(List(ArchiveFile), ArchiveError)

extract_tar_gz

</>

pub fn extract_tar_gz(
  data: BitArray,
) -> Result(List(ArchiveFile), ArchiveError)

extract_tar_gz_selected

</>

pub fn extract_tar_gz_selected(
  data: BitArray,
  select: fn(List(String)) -> List(#(String, String)),
) -> Result(List(ArchiveFile), ArchiveError)

Select archive members from the full regular-file inventory before loading their contents. Each selected pair contains the member and its output path.

max_decompressed_bytes

</>

pub const max_decompressed_bytes: Int

package_paths

</>

pub fn package_paths(
  paths: List(String),
  directory: String,
) -> List(#(String, String))

Scope the full inventory before selecting files or inferring package roots.

sha256_hex

</>

pub fn sha256_hex(data: BitArray) -> Result(String, ArchiveError)

text_contents

</>

pub fn text_contents(
  file: ArchiveFile,
) -> Result(String, ArchiveError)