ExBoxPacker.Box protocol (ExBoxPacker v0.2.0)

Copy Markdown View Source

A box/container available for packing. Elixir analog of BoxPacker's Box interface.

Outer dimensions/weight are used for shipping; inner dimensions bound the packable space. All values are integers in the same units used for items.

Summary

Types

t()

All the types that implement this protocol.

Functions

empty_weight(box)
inner_depth(box)
inner_length(box)
inner_width(box)
max_weight(box)
outer_depth(box)
outer_length(box)
outer_width(box)
reference(box)

Types

t()

@type t() :: term()

All the types that implement this protocol.

Functions

empty_weight(box)

@spec empty_weight(t()) :: integer()

inner_depth(box)

@spec inner_depth(t()) :: integer()

inner_length(box)

@spec inner_length(t()) :: integer()

inner_width(box)

@spec inner_width(t()) :: integer()

max_weight(box)

@spec max_weight(t()) :: integer()

outer_depth(box)

@spec outer_depth(t()) :: integer()

outer_length(box)

@spec outer_length(t()) :: integer()

outer_width(box)

@spec outer_width(t()) :: integer()

reference(box)

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