Estated v0.1.0 Estated.Warning View Source

Warnings happen because the input address was unable to be reconciled to a single property, either because the address could not be found, or a property could not be matched to a successfully parsed address.

Link to this section Summary

Types

Code describing the type of warning that occurred.

Description of the warning.

t()

Warning response

Title of the warning.

Link to this section Types

Link to this type

code()

View Source (since 0.1.0)
code() :: String.t()

Code describing the type of warning that occurred.

Eg. PW01

Link to this type

description()

View Source (since 0.1.0)
description() :: String.t()

Description of the warning.

Eg. No property was found for the given input

Link to this type

t()

View Source (since 0.1.0)
t() :: %Estated.Warning{
  code: code() | nil,
  description: description() | nil,
  metadata: Estated.WarningMetadata.t() | nil,
  title: title() | nil
}

Warning response

Link to this type

title()

View Source (since 0.1.0)
title() :: String.t()

Title of the warning.

Eg. Property Warning