View Source RDF.BlankNode.Generator.Algorithm behaviour (RDF.ex v1.2.0)

A behaviour for implementations of blank node identifier generation algorithms.

The RDF.BlankNode.Generator executes such an algorithm and holds its state.

Summary

Callbacks

generate(state)

Generates a blank node.

generate_for(value, state)

Generates a blank node for a given string.

init(opts)

Returns the initial state of the algorithm.

Callbacks

generate(state)

@callback generate(state :: map()) :: {RDF.BlankNode.t(), map()}

Generates a blank node.

An implementation should compute a blank node from the given state and return a tuple consisting of the generated blank node and the new state.

generate_for(value, state)

@callback generate_for(value :: any(), state :: map()) :: {RDF.BlankNode.t(), map()}

Generates a blank node for a given string.

Every call with the same string must return the same blank node.

An implementation should compute a blank node for the given string from the given state and return a tuple consisting of the generated blank node and the new state.

init(opts)

@callback init(opts :: map()) :: map()

Returns the initial state of the algorithm.