Modules
Processes images in your own code, and holds the configuration that
ImagePipe.Plug serves images with.
Stores processed images as files on local disk. The cache option takes
its options, and needs an instance, which starts the processes that track
the cache's size (see ImagePipe.child_spec/1)
Reusable host configuration shared by the Plug and direct execution.
Serves ImagePipe's image API from a Plug or Phoenix router. Each place it is plugged in is a mount, with its own options.
Raised by ImagePipe.Plug when a response fails after its 200 status and
headers were sent.
Resolves presets that the static :presets map does not define, while a
request is served.
Limits how many images are processed at once, with a queue for requests that wait for a turn and a deadline for each image.
The complete output of ImagePipe.run/4 or ImagePipe.write/5.
Behaviour for source adapters, and the shape of the :sources option of
ImagePipe.config/1.
Cache storage and freshness policy for originals and processed images.
Source-owned cache facts used by internal and HTTP cache decisions.
Cache settings shared by source adapters.
Source adapter for image files below a directory.
Source adapter for images fetched over HTTP and HTTPS.
Product-neutral bucket or container object source, such as s3://bucket/key.
Origin cache evidence, kept separately from the source's byte identity.
Root-relative path source.
Validated source information returned by an adapter's ImagePipe.Source.resolve/3.
Source bytes returned by an ImagePipe.Source adapter.
Source adapter for objects in S3 and S3-compatible storage.
Credential provider that assumes an IAM role with STS AssumeRole, usually
a role in another account.
Credential provider for ECS, Fargate, and EKS container credentials.
Behaviour for S3 credential providers.
Fetches S3 credentials from a provider at startup, so the first request that needs them doesn't wait.
Credential provider for the IAM role attached to an EC2 instance, including Elastic Beanstalk, read from the instance metadata service (IMDSv2).
Credential provider for EKS IAM roles for service accounts (IRSA), using
STS AssumeRoleWithWebIdentity.
Absolute HTTP and HTTPS source.
Attaches ImagePipe's optional Logger handler and span tracer.
Behaviour for detectors that find faces and objects for detect and
anchor=smart-face crops.
Routes requested classes to an ordered list of detectors and merges their regions.
ImagePipe.Transform.Detector for faces, backed by the optional image_vision
dependency (Image.FaceDetection, YuNet). The dependency is not declared by
ImagePipe — hosts opt in. When absent, available?/1 is false and callers fall
back gracefully.
ImagePipe.Transform.Detector for general objects, backed by the optional
image_vision dependency (Image.Detection, RT-DETR, COCO-80). The dependency
is not declared by ImagePipe — hosts opt in. When absent, available?/1 is
false and callers fall back gracefully.
One-shot worker that pre-loads a detector's models at boot.