AshOnetime.Codec behaviour (ash_onetime v0.5.0)

Copy Markdown View Source

Contract for response codecs and shared boundary validation.

Summary

Callbacks

decode(binary, binary, map, keyword)
encode(term, map, keyword)
format_tag()

Functions

ash_resource?(arg1)
hard_limits()
max_bytes(contract)
protect_only_ceilings()

The protect-only limit keys with their package ceilings (the half of the limit vocabulary that bounds the key/verification/cache paths, not the response codec). Single source shared with Response.response_limit/1's typo-discrimination set.

structural_limits(contract)

Returns the response structural limits for contract, merging the contract's declared limits over the package hard limits. Only the hard-limit keys are honored (max_response_*); any other keys in contract.limits are ignored, so this is safe to call on an un-normalized map. Values are taken as-is — callers building a %AshOnetime.Response.Contract{} must validate values (the Response.contract/4 path does so via normalize_response_limits/1, which selects + validates the response-relevant subset before delegating to normalize_limits/1).

validate_tag(tag)
validate_value(value, contract, phase \\ :value)

Callbacks

decode(binary, binary, map, keyword)

@callback decode(binary(), binary(), map(), keyword()) ::
  {:ok, term()} | {:error, AshOnetime.Error.t()}

encode(term, map, keyword)

@callback encode(term(), map(), keyword()) ::
  {:ok, binary(), binary()} | {:error, AshOnetime.Error.t()}

format_tag()

@callback format_tag() :: binary()

Functions

ash_resource?(arg1)

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

hard_limits()

@spec hard_limits() :: map()

max_bytes(contract)

@spec max_bytes(map()) :: pos_integer()

protect_only_ceilings()

@spec protect_only_ceilings() :: keyword()

The protect-only limit keys with their package ceilings (the half of the limit vocabulary that bounds the key/verification/cache paths, not the response codec). Single source shared with Response.response_limit/1's typo-discrimination set.

structural_limits(contract)

@spec structural_limits(map()) :: map()

Returns the response structural limits for contract, merging the contract's declared limits over the package hard limits. Only the hard-limit keys are honored (max_response_*); any other keys in contract.limits are ignored, so this is safe to call on an un-normalized map. Values are taken as-is — callers building a %AshOnetime.Response.Contract{} must validate values (the Response.contract/4 path does so via normalize_response_limits/1, which selects + validates the response-relevant subset before delegating to normalize_limits/1).

validate_tag(tag)

@spec validate_tag(term()) :: :ok | {:error, AshOnetime.Error.t()}

validate_value(value, contract, phase \\ :value)

@spec validate_value(term(), map(), atom()) :: :ok | {:error, AshOnetime.Error.t()}