ImagePipe.Source.Response (image_pipe v0.1.0)

Source bytes returned by an ImagePipe.Source adapter.

Exactly one of stream or path must be present. Streams are consumed lazily and must release their resources when enumeration halts. Adapters opening resources before enumeration also supply an idempotent close function. Source.with_fetched/3 closes it even when no body is consumed.

Summary

Types

t()

Functions

close(response)

Releases a response obtained directly through Source.fetch/3.

Types

t()

@type t() :: %ImagePipe.Source.Response{
  close: (-> :ok) | nil,
  origin: ImagePipe.Source.Origin.t() | nil,
  path: Path.t() | nil,
  stream: Enumerable.t() | nil
}

Functions

close(response)

Releases a response obtained directly through Source.fetch/3.