pub type Error {
  FailedToGetDirectory
  FailedToCreateDirectory(
    path: String,
    error: simplifile.FileError,
  )
  FailedToWriteToFile(path: String, error: simplifile.FileError)
  FailedToReadFile(path: String, error: simplifile.FileError)
  FailedToDeleteDirectory(
    path: String,
    error: simplifile.FileError,
  )
  FailedToReadDirectory(
    path: String,
    error: simplifile.FileError,
  )
  RequestFailed(url: String, error: httpc.HttpError)
  RequestReturnedIncorrectResponse(url: String, status_code: Int)
  ResponseJsonInvalid(json.DecodeError)
  FileContainedInvalidJson(json.DecodeError)
  FailedToDecodeHexTarball(package: String)
}

Constructors

• FailedToGetDirectory

  Failed to find a suitable directory to store data in

• FailedToCreateDirectory(
    path: String,
    error: simplifile.FileError,
  )

  Failed to create a directory

• FailedToWriteToFile(path: String, error: simplifile.FileError)

  Failed to write to a file

• FailedToReadFile(path: String, error: simplifile.FileError)

  Failed to read a file

• FailedToDeleteDirectory(
    path: String,
    error: simplifile.FileError,
  )

  Failed to delete a directory

• FailedToReadDirectory(path: String, error: simplifile.FileError)

  Failed to read a directory

• RequestFailed(url: String, error: httpc.HttpError)

  Failed to send an HTTP request

• RequestReturnedIncorrectResponse(url: String, status_code: Int)

  An HTTP request returned a response that was not 200 OK

• ResponseJsonInvalid(json.DecodeError)

  An HTTP request returned invalid JSON

• FileContainedInvalidJson(json.DecodeError)

  The cached data file contained invalid JSON

• FailedToDecodeHexTarball(package: String)

  Decoding the Hex tarball for a particular package failed.

pub type File {
  TextFile(name: String, contents: String)
  BinaryFile(name: String, contents: BitArray)
}

Constructors

• TextFile(name: String, contents: String)

  A text file containing UTF-8 data

  Arguments

  name

  The path to the file within the package, for example src/gleam/io.gleam

  contents

  The contents of the text file

• BinaryFile(name: String, contents: BitArray)

  A binary file which doesn’t contain valid UTF-8

  Arguments

  name

  The path to the file within the package, for example priv/data/something.bin

  contents

  The binary contents of the file

pub type Options {
  Options(
    write_to_file: Bool,
    refresh_package_list: Bool,
    write_packages_to_disc: Bool,
    read_packages_from_disc: Bool,
    print_logs: Bool,
  )
}

Constructors

• Options(
    write_to_file: Bool,
    refresh_package_list: Bool,
    write_packages_to_disc: Bool,
    read_packages_from_disc: Bool,
    print_logs: Bool,
  )

  Arguments

  write_to_file

  Whether or not to write the package index data to a file for caching later. It is recommended to leave this as True, as setting it to False will require sending a request to the Gleam packages API every time you need to access data. However, you may want to set it to False if you don’t want pack to write to your file system.

  refresh_package_list

  If set to True, pack will ignore any cached package information and perform a full rescan of the Gleam package index. This is useful if the cached information is outdated.

  write_packages_to_disc

  Whether or not to write packages to disc when downloading. Like write_to_file, setting this to False will require sending requests to Hex for every package every time pack is invoked.

  read_packages_from_disc

  If set to False, pack will ignore existing source code downloaded for packages and redownload all of them. This is useful if downloaded packages are outdated and you need the newer source code.

  print_logs

  Whether or not to print out logs of operations pack is performing. It can be helpful to user experience to leave these on, as downloading from the package index can take a long time, and without logs there is no indication of progress. However, this will print a line for every single package downloaded so it may be preferable to disable it.

pub opaque type Pack

pub type Package {
  Package(
    name: String,
    description: String,
    latest_version: String,
    repository: option.Option(String),
    updated_at: Int,
    releases: List(Release),
  )
}

Constructors

• Package(
    name: String,
    description: String,
    latest_version: String,
    repository: option.Option(String),
    updated_at: Int,
    releases: List(Release),
  )

pub type Release {
  Release(version: String, downloads: Int, updated_at: Int)
}

Constructors

• Release(version: String, downloads: Int, updated_at: Int)