Link to this section Summary

Types

Error response codes returned by from_object/1.

t()

This struct describes a single tree object so it can be manipulated in memory.

Renders a tree structure from an Xgit.Object.

Renders this tree structure into a corresponding Xgit.Object.

Return true if the value is a tree struct that is valid.

from_object_reason() :: :not_a_tree | :invalid_format | :invalid_tree

Error response codes returned by from_object/1.

t() :: %Xgit.Tree{entries: [Xgit.Tree.Entry.t()]}

This struct describes a single tree object so it can be manipulated in memory.

from_object(object :: Xgit.Object.t()) ::
  {:ok, tree :: t()} | {:error, from_object_reason()}

Renders a tree structure from an Xgit.Object.

{:ok, tree} if the object contains a valid tree object.

{:error, :not_a_tree} if the object contains an object of a different type.

{:error, :invalid_format} if the object says that is of type tree, but can not be parsed as such.

{:error, :invalid_tree} if the object can be parsed as a tree, but the entries are not well formed or not properly sorted.

to_object(tree :: t()) :: Xgit.Object.t()

Renders this tree structure into a corresponding Xgit.Object.

valid?(tree :: any()) :: boolean()

Return true if the value is a tree struct that is valid.

All of the following must be true for this to occur: