Astral.Image.Format (Astral v0.1.2)

Copy Markdown View Source

Canonical image format normalization for Astral's image pipeline.

Summary

Types

t()

Functions

extension(atom)

Return the canonical file extension for an output format.

extensions()

Return supported local image file extensions.

from_path(path)

Return the source format represented by a filesystem path.

mime_type(format)

Return a browser MIME type for a format.

normalize(format)

Normalize a user-provided output format.

optimizable?(format)

Return true when a format can be emitted by the optimization backend.

output!(format)

Normalize and validate a user-provided output format.

suffix(format)

Return the suffix option expected by the Image package writer.

Types

t()

@type t() :: :jpg | :jpeg | :png | :webp | :avif | :svg | :unknown

Functions

extension(atom)

@spec extension(t()) :: String.t()

Return the canonical file extension for an output format.

extensions()

@spec extensions() :: [String.t()]

Return supported local image file extensions.

from_path(path)

@spec from_path(String.t()) :: t()

Return the source format represented by a filesystem path.

mime_type(format)

@spec mime_type(t()) :: String.t()

Return a browser MIME type for a format.

normalize(format)

@spec normalize(atom() | String.t()) :: t()

Normalize a user-provided output format.

optimizable?(format)

@spec optimizable?(term()) :: boolean()

Return true when a format can be emitted by the optimization backend.

output!(format)

@spec output!(atom() | String.t()) :: :jpg | :jpeg | :png | :webp | :avif

Normalize and validate a user-provided output format.

suffix(format)

@spec suffix(t()) :: String.t()

Return the suffix option expected by the Image package writer.