# image_pipe_url v0.1.0 - Table of Contents

> Builds and signs ImagePipe image URLs without the image processing runtime.

## Pages

- [ImagePipe URL](readme.md)
- [Changelog](changelog.md)
- [LICENSE](license.md)

## Modules

- URL builder
  - [ImagePipe.URL](ImagePipe.URL.md): Builds processing plans and generates signed ImagePipe URLs.
  - [ImagePipe.URL.Config](ImagePipe.URL.Config.md): URL settings shared by a builder and the server that serves its URLs.
  - [ImagePipe.URL.Helpers](ImagePipe.URL.Helpers.md): An `image_url/2` macro that builds image URLs in templates and checks their
options at compile time.

- Plan model
  - [ImagePipe.Plan](ImagePipe.Plan.md): An immutable processing plan built through the `ImagePipe` builder API.
  - [ImagePipe.Plan.Spec.Issue](ImagePipe.Plan.Spec.Issue.md): A problem with a plan's options or source, returned by
`ImagePipe.URL.validate/1`, `ImagePipe.URL.url/3`, and
`ImagePipe.URL.url_with_issues/3`, and by
`ImagePipe.validate/2` and `ImagePipe.run/4` in `image_pipe`.

- Sources
  - [ImagePipe.Plan.Source](ImagePipe.Plan.Source.md): Product-neutral source identifiers produced by parsers.

  - [ImagePipe.Plan.Source.Object](ImagePipe.Plan.Source.Object.md): Product-neutral bucket or container object source, such as `s3://bucket/key`.

  - [ImagePipe.Plan.Source.Path](ImagePipe.Plan.Source.Path.md): Root-relative path source.
  - [ImagePipe.Plan.Source.URL](ImagePipe.Plan.Source.URL.md): Absolute HTTP and HTTPS source.

- Encoder options
  - [ImagePipe.Plan.Output.AvifOptions](ImagePipe.Plan.Output.AvifOptions.md): libvips `heifsave` (AVIF) encoder options (neutral; imgproxy `avifo`/`AVIF_SPEED` translate here).
  - [ImagePipe.Plan.Output.JpegOptions](ImagePipe.Plan.Output.JpegOptions.md): libvips `jpegsave` encoder options (product-neutral; the imgproxy parser
translates `jpgo` into this). Every field is optional (`nil` ⇒ emit no token,
leaving libvips' default).

  - [ImagePipe.Plan.Output.PngOptions](ImagePipe.Plan.Output.PngOptions.md): libvips `pngsave` encoder options (neutral; imgproxy `pngo` translates here).
  - [ImagePipe.Plan.Output.WebpOptions](ImagePipe.Plan.Output.WebpOptions.md): libvips `webpsave` encoder options (neutral; imgproxy `webpo` translates here).