Validate protocol (Anoma v0.32.0)

I am a protocol that can be used to validate a struct. I am used to validate GRPC requests.

GRPC requests can contain nil instead of a value, where the codebase expects a struct.

For example, the request below is valid GRPC.

%Anoma.Protobuf.Intents.Add.Request{
  node_info: nil,
  intent: nil,
  __unknown_fields__: []
}

However, if the node_info field is not expected to be nil, this will cause crashes.

These types of errors can be caught early by using this protocol.

Summary

error_map()

An error_map map is a map that contains error data about a request.

invalid_error()

A key in a map that was invalid.

nil_error()

An atom that was nil in a map.

t()

All the types that implement this protocol.

valid?(request)

@type error_map() :: %{nil: [atom()], invalid: [{atom(), invalid_error()}]}

An error_map map is a map that contains error data about a request.

E.g.,

%{
  nil: [:intent],
  invalid: [node_info: %{nil: [:node_id], invalid: []}]}
}

@type invalid_error() :: {atom(), error_map()}

A key in a map that was invalid.

@type nil_error() :: atom()

An atom that was nil in a map.

@type t() :: term()

All the types that implement this protocol.

@spec valid?(t()) :: {:ok, :valid} | {:error, :invalid, error_map()}