package
8.0.0
Repository: https://github.com/axone-protocol/axoned.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
AssertAtom resolves a term and attempts to convert it into an engine.Atom if possible.
AssertByte resolves a term and attempts to convert it into a byte if possible.
AssertCharacter resolves a term and attempts to convert it into an engine.Atom if possible.
AssertCharacterCode resolves a term and attempts to convert it into a rune if possible.
AssertIsGround resolves a term and returns it if it is ground.
AssertList resolves a term as a list and returns it as a engine.Compound.
AssertPair resolves a term as a pair and returns the pair components.
AssertURIComponent resolves a term as a URI component and returns it as an URIComponent.
AtomToString try to convert a given atom to a string.
ByteListTermToBytes try to convert a given list of bytes into native golang []byte.
BytesToByteListTerm try to convert a given golang []byte into a list of bytes.
CharacterCodeListTermToString try to convert a given list of character codes to a string.
CharacterListTermToString try to convert a given list of characters to a string.
Decode decodes the given byte slice with the given encoding.
Encode encodes the given string with the given encoding.
ErrorTerm returns a term representing the given error, suitable for use in the syntax_error/2 predicate.
ExtractJSONTerm is a utility function that would extract all attribute of a JSON object that is represented in prolog with the `json` atom.
GetOption returns the value of the first option with the given name in the given options.
GetOptionAsAtomWithDefault is a helper function that returns the value of the first option with the given name in the given options.
GetOptionWithDefault returns the value of the first option with the given name in the given options, or the given default value if no option is found.
IsEmptyList returns true if the given term is an empty list.
IsGround returns true if the given term holds no free variables.
IsList returns true if the given term is a list.
JSONBool returns the compound term @(true) if b is true, otherwise @(false).
JSONEmptyArray returns is the compound term @([]).
JSONNull returns the compound term @(null).
ListHead returns the first element of the given list.
ListIterator returns a list iterator.
OctetListTermToString try to convert a given list of bytes to a string.
PredicateMatches returns a function that matches the given predicate against the given other predicate.
ResourceContext returns a term representing the context resource.
ResourceGas returns a term representing the gas resource with the given descriptor, consumed and limit at the given context.
ResourceModule returns a term representing the module resource with the given name.
StringToAtom converts a string to an atom.
StringToByteListTerm converts a string (utf8) to a term representing a list of bytes.
StringToCharacterCodeListTerm converts a string to a term representing a list of character codes.
StringToCharacterListTerm converts a string to a term representing a list of characters.
StringToOctetListTerm converts a string (utf8) to a term representing a list of bytes.
TermHexToBytes try to convert an hexadecimal encoded atom to native golang []byte.
TextTermToString try to convert a given Text term to a string.
Tuple is a predicate which unifies the given term with a tuple of the given arity.
UnifyFunctional is a generic unification which unifies a set of input terms with a set of output terms, using the given conversion functions maintaining the function's relationship.
UnifyFunctionalPredicate is the predicate version of UnifyFunctional returning a promise.
UnwrapSDKContext retrieves a Context from a context.Context instance attached with WrapSDKContext.
No description provided by the author
ValidEncoding returns a term representing the valid encoding with the given name.
WithError adds the error term to the exception term if possible.

# Variables

AtomAs is the term used to indicate the as encoding type option.
AtomAt are terms with principal functor (@)/1 used to represent special values in json objects.
AtomDIDComponents is a term which represents a DID as a compound term `did_components(Method, ID, Path, Query, Fragment)`.
AtomDot is the term used to represent the dot in a list.
AtomEmpty is the term used to represent empty.
AtomEmptyArray is the term [].
AtomEmptyList is the term used to represent an empty list.
AtomEncoding is the term used to indicate the encoding type option.
AtomError is the term used to indicate the error.
AtomFalse is the term false.
AtomFragment is the term used to indicate the fragment component.
AtomHex is the term used to indicate the hexadecimal encoding type option.
AtomJSON are terms with principal functor json/1 used to represent json objects.
AtomNull is the term null.
No description provided by the author
AtomOctet is the term used to indicate the byte encoding type option.
No description provided by the author
No description provided by the author
AtomPadding is the term used to indicate the padding encoding type option.
AtomPair are terms with principal functor (-)/2.
AtomPath is the term used to indicate the path component.
No description provided by the author
No description provided by the author
AtomQueryValue is the term used to indicate the query value component.
AtomResourceContext is the atom denoting the "context" resource.
AtomResourceGas is the atom denoting the "gas" resource.
AtomResourceModule is the atom denoting the "module" resource.
AtomSegment is the term used to indicate the segment component.
AtomText is the term used to indicate the atom text.
AtomTrue is the term true.
AtomTypeAtom is the term used to represent the atom type.
AtomTypeByte is the term used to represent the byte type.
AtomTypeCharacter is the term used to represent the character type.
AtomTypeCharacterCode is the term used to represent the character code type.
AtomTypeCharset is the term used to represent the charset type.
AtomTypeCryptographicAlgorithm is the term used to represent the cryptographic algorithm type.
AtomTypeDID is the term used to represent the DID type.
AtomTypeHashAlgorithm is the term used to represent the hash algorithm type.
AtomTypeIOMode is the term used to represent the IO mode type.
AtomTypeJSON is the term used to indicate the json type.
AtomTypeList is the term used to represent the list type.
AtomTypeNumber is the term used to represent the number type.
AtomTypeOption is the term used to represent the option type.
AtomTypePair is the term used to indicate the pair type.
AtomTypeStream is the term used to represent the stream type.
AtomTypeText is the term used to represent the text type.
AtomTypeURIComponent is the term used to represent the URI component type.
AtomUtf8 is the term used to indicate the UTF-8 encoding type option.
AtomValidEmptyList is the atom denoting a valid empty list.
AtomValidEncoding is the atom denoting a valid encoding.

# Type aliases

ConvertFunc is a function mapping a domain which is a list of terms with a codomain which is a set of terms.