Bargad

v1.0.1

Bargad v1.0.1 Bargad.Utils View Source

Utility functions required by Bargad.Merkle, Bargad.Log, Bargad.Map.

Link to this section Summary

Types

backend()
hash()
hash_algorithm()
tree()
tree_node()
tree_type()

Functions

decode_node(node)

Decodes a binary into a tree_node/0 using exprotobuf

decode_tree(tree)

Decodes a binary into a tree/0 using exprotobuf

delete_node(tree, key)
encode_node(node)

Encodes tree_node/0 into a binary using exprotobuf

encode_tree(tree)

Encodes tree/0 into a binary using exprotobuf

generate_tree_id()

Generates a unique TreeId for every tree

get_backend_module(backend)

Utility function to retrieve the backend module from backend

get_node(tree, key)

Utility function for retrieving a tree node

make_hash(tree, data)

Hashes the binary data supplied based on the hash algorithm hash_algorithm/0 specified in t:tree

make_map_node(tree, left, right)
make_node(tree, left, right)

Creates an inner node in the tree of type tree_node/0

make_node(tree, hash, children, size, metadata)

Creates a new node in the tree of type tree_node/0

make_tree(tree_type, tree_name, hash_function, backend)

Creates a new tree of type tree/0

salt_node(k, v)
set_node(tree, key, value)

Utility function for persisting a tree node

tuple_list_to_map(tpl)

Helper function to convert a Tuple List into a map

Link to this section Types

Link to this section Functions

Link to this function decode_node(node) View Source

Decodes a binary into a tree_node/0 using exprotobuf.

Link to this function decode_tree(tree) View Source

Decodes a binary into a tree/0 using exprotobuf.

Link to this function encode_node(node) View Source

Encodes tree_node/0 into a binary using exprotobuf.

Link to this function encode_tree(tree) View Source

Encodes tree/0 into a binary using exprotobuf.

Link to this function generate_tree_id() View Source

Generates a unique TreeId for every tree.

This TreeId is used by Storage and Bargad.TreeStorage for persisting tree/0 and tree_node/0

Link to this function get_backend_module(backend) View Source

Utility function to retrieve the backend module from backend.

Link to this function get_node(tree, key) View Source

Utility function for retrieving a tree node.

Calls Storage.get_node/2.

Link to this function make_hash(tree, data) View Source

Hashes the binary data supplied based on the hash algorithm hash_algorithm/0 specified in t:tree.

Link to this function make_map_node(tree, left, right) View Source
Link to this function make_node(tree, left, right) View Source

Creates an inner node in the tree of type tree_node/0.

Creates a new node with its children as left and right.

Link to this function make_node(tree, hash, children, size, metadata) View Source

Creates a new node in the tree of type tree_node/0.

Link to this function make_tree(tree_type, tree_name, hash_function, backend) View Source 
make_tree(tree_type(), binary(), hash_algorithm(), backend()) :: tree()

Creates a new tree of type tree/0.

Called by Bargad.Merkle.new/4 when a new Bargad.Map or Bargad.Log has to be created.

Link to this function set_node(tree, key, value) View Source

Utility function for persisting a tree node.

Calls Storage.set_node/3.

Link to this function tuple_list_to_map(tpl) View Source 
tuple_list_to_map(tuple()) :: map()

Helper function to convert a Tuple List into a map.

This is required as Bargad.Trees stores a map as a List of Tuple.