PlugImageProcessing.Middleware protocol (plug_image_processing v0.9.1)

View Source

Protocol for implementing middleware in the image processing pipeline.

Middleware can be used to add security checks, modify headers, validate requests, or perform any other processing on the connection before or after image operations.

Summary

Types

t()

Functions

enabled?(middleware, conn)

Determines if this middleware should be enabled for the given connection.

run(middleware, conn)

Executes the middleware logic on the connection.

Types

t()

@type t() :: struct()

Functions

enabled?(middleware, conn)

@spec enabled?(t(), Plug.Conn.t() | nil) :: boolean()

Determines if this middleware should be enabled for the given connection.

This allows conditional activation of middleware based on configuration or request parameters.

Parameters

  • middleware - The middleware struct containing configuration
  • conn - The Plug.Conn struct to check (may be nil during initialization)

Returns

  • true if the middleware should run, false otherwise

run(middleware, conn)

@spec run(t(), Plug.Conn.t()) :: Plug.Conn.t()

Executes the middleware logic on the connection.

This function should process the connection and return a potentially modified connection. It may halt the connection if validation fails.

Parameters

  • middleware - The middleware struct containing configuration
  • conn - The Plug.Conn struct to process

Returns

  • Modified Plug.Conn struct (may be halted)