Elixir Inspect用法及代碼示例

Inspect 協議將 Elixir 數據結構轉換為代數文檔。

本文檔涉及為您自己的數據結構實現 Inspect 協議。要了解有關使用檢查的更多信息，請參閱 Kernel.inspect/2 和 IO.inspect/2 。

inspect/2 函數接收要檢查的實體，然後是檢查選項，由結構 Inspect.Opts 表示。代數文檔的構建是使用 Inspect.Algebra 完成的。

例子

很多時候，檢查結構可以在現有實體的函數中實現。例如，這裏是 MapSet 的 inspect/2 實現：

defimpl Inspect, for: MapSet do
  import Inspect.Algebra

  def inspect(map_set, opts) do
    concat(["#MapSet<", to_doc(MapSet.to_list(map_set), opts), ">"])
  end
end

concat/1 函數來自 Inspect.Algebra ，它將代數文檔連接在一起。在上麵的示例中，它連接字符串 "#MapSet<" 、 Inspect.Algebra.to_doc/2 返回的文檔和最終字符串 ">" 。我們為模塊名稱添加前綴# 以表示檢查演示實際上不是有效的 Elixir 語法。

最後，音符字符串本身是有效的代數文檔，在打印時保持格式不變。這意味著您的 Inspect 實現可能隻是返回一個字符串，盡管這將沒有任何pretty-printing。

錯誤處理

如果在檢查您的結構時出現錯誤，Elixir 將引發 ArgumentError 錯誤並自動回退到打印結構的原始表示。

但是，您可以通過直接調用 Inspect 實現來訪問底層錯誤。例如，要測試上麵的 Inspect.MapSet ，您可以調用它：

Inspect.MapSet.inspect(MapSet.new(), %Inspect.Opts{})

導出

Inspect 協議可以派生以隱藏結構中的某些字段，因此它們不會出現在日誌、檢查和類似內容中。這對於包含私人信息的字段特別有用。

選項 :only 和 :except 可以與 @derive 一起使用，以指定哪些字段應該和不應該出現在代數文檔中：

defmodule User do
  @derive {Inspect, only: [:id, :name]}
  defstruct [:id, :name, :address]
end

inspect(%User{id: 1, name: "Homer", address: "742 Evergreen Terrace"})
#=> #User<id: 1, name: "Homer", ...>