Module convex.core

Package convex.core

Class Receipt

java.lang.Object

convex.core.data.AObject

convex.core.data.ACell

convex.core.data.ACountable<MapEntry<Keyword,ACell>>

convex.core.data.ADataStructure<MapEntry<Keyword,ACell>>

convex.core.data.AMap<Keyword,ACell>

convex.core.data.ARecord

convex.core.Receipt

All Implemented Interfaces:

IAssociative<Keyword,ACell>, IValidated, IWriteable, Map<Keyword,ACell>

public class Receipt
extends ARecord

Transaction Receipt record. This forms part of the official CVM state transition, so must be correctly computed and encoded

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class convex.core.data.ARecord

DEFAULT_VALUE

Fields inherited from class convex.core.data.ADataStructure

count

Fields inherited from class convex.core.data.ACell

cachedRef, memorySize

Fields inherited from class convex.core.data.AObject

encoding

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Receipt(boolean error, ACell value, AVector<AVector<ACell>> log)

Method Summary

Modifier and Type	Method	Description
static Receipt	create(boolean isError, ACell value, AVector<AVector<ACell>> log)
static Receipt	create(ACell result)
static Receipt	createError(ACell errorCode)
int	encode(byte[] bs, int pos)	Writes this Cell's encoding to a byte array, including a tag byte which will be written first.
int	encodeRaw(byte[] bs, int pos)	Writes this Cell's encoding to a byte array, excluding the tag byte.
boolean	equals(ACell a)	Checks for equality with another Cell.
boolean	equals(Receipt a)
ACell	get(Keyword k)	Gets the record field content for a given key, or null if not found.
ACell	getErrorCode()	Gets the error code of this Receipt, or null if not an error
RecordFormat	getFormat()	Gets the RecordFormat instance that describes this Record's layout
<R extends ACell> Ref<R>	getRef(int i)	Gets a numbered child Ref from within this Cell.
int	getRefCount()	Gets the number of Refs contained within this Cell.
ACell	getResult()	Gets the result value of this Receipt, or null if an error
byte	getTag()	Gets the tag byte for this record type.
final boolean	isCVMValue()	Returns true if this cell is a first class CVM Value allowable in the CVM state Sub-structural cells that are not themselves first class values should return false Records and types that are not permissible on the CVM should return false.
boolean	isError()
static Receipt	read(byte tag, Blob b, int pos)
Receipt	updateRefs(IRefFunction func)	Updates all child Refs in this object using the given function.
void	validateCell()	Validates the local structure and invariants of this cell.

Methods inherited from class convex.core.data.ARecord

accumulateEntrySet, accumulateKeySet, accumulateValues, assoc, assocEntry, containsKey, containsValue, dissoc, dissoc, empty, entryAt, entrySet, estimatedEncodingSize, forEach, get, getEntry, getEntryByHash, getKeyRefEntry, getKeys, getType, getValuesArray, isCanonical, keySet, reduceEntries, reduceValues, toCanonical, toHashMap, values

Methods inherited from class convex.core.data.AMap

clear, conj, containsKey, containsKeyRef, containsValue, entryVector, filterValues, get, get, get, getElementRef, merge, print, put, putAll, remove, slice, slice

Methods inherited from class convex.core.data.ADataStructure

checkIndex, conjAll, count, isDataValue, isEmpty, size, toCVMString

Methods inherited from class convex.core.data.ACell

attachMemorySize, attachRef, cachedEncoding, cachedHash, calcMemorySize, createEncoding, createRef, equals, genericEquals, getCanonical, getChildRefs, getEncoding, getEncodingLength, getHash, getMemorySize, getMemorySize, getRef, hashCode, isEmbedded, toString, validate

Methods inherited from class convex.core.data.AObject

attachEncoding, print, print

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, size

Constructor Details

Receipt

protected Receipt(boolean error,
 ACell value,
 AVector<AVector<ACell>> log)

Method Details

create

public static Receipt create(ACell result)

create

public static Receipt create(boolean isError,
 ACell value,
 AVector<AVector<ACell>> log)

createError

public static Receipt createError(ACell errorCode)

get

public ACell get(Keyword k)

Description copied from class: ARecord

Gets the record field content for a given key, or null if not found.

Specified by:

get in class ARecord

Parameters:

k - Key to look up in this record

Returns:

Field value for the given key

getErrorCode

public ACell getErrorCode()

Gets the error code of this Receipt, or null if not an error

Returns:

Error code (probably a Keyword or nil)

getResult

public ACell getResult()

Gets the result value of this Receipt, or null if an error

Returns:

Result from this Receipt

getTag

public byte getTag()

Description copied from class: ARecord

Gets the tag byte for this record type. The Tag is the byte used to identify the record in the binary encoding.

Specified by:

getTag in class ARecord

Returns:

Record tag byte

isCVMValue

public final boolean isCVMValue()

Description copied from class: ACell

Returns true if this cell is a first class CVM Value allowable in the CVM state Sub-structural cells that are not themselves first class values should return false Records and types that are not permissible on the CVM should return false. Pretty much everything else should return true. Note: CVM values might not be in a canonical format, e.g. temporary data structures

Overrides:

isCVMValue in class ARecord

Returns:

true if the object is a CVM Value, false otherwise

getFormat

public RecordFormat getFormat()

Description copied from class: ARecord

Gets the RecordFormat instance that describes this Record's layout

Specified by:

getFormat in class ARecord

Returns:

RecordFormat instance

validateCell

public void validateCell()
                  throws InvalidDataException

Description copied from class: ACell

Validates the local structure and invariants of this cell. Called by validate() super implementation. Should validate directly contained data, but should not validate all other structure of this cell. In particular, should not traverse potentially missing child Refs.

Specified by:

validateCell in class ACell

Throws:

InvalidDataException - If the Cell is invalid

equals

public boolean equals(ACell a)

Description copied from class: ACell

Checks for equality with another Cell. In general, Cells are considered equal if they have the same canonical representation, i.e. an identical encoding with the same hash value. Subclasses SHOULD override this if they have a more efficient equals implementation. MUST NOT require reads from Store.

Specified by:

equals in class ACell

Parameters:

a - Cell to compare with. May be null.

Returns:

True if this cell is equal to the other object

equals

public boolean equals(Receipt a)

encode

public int encode(byte[] bs,
 int pos)

Description copied from class: ACell

Writes this Cell's encoding to a byte array, including a tag byte which will be written first. Cell must be canonical, or else an error may occur.

Specified by:

encode in interface IWriteable

Specified by:

encode in class ACell

Parameters:

bs - A byte array to which to write the encoding

pos - The offset into the byte array

Returns:

New position after writing

encodeRaw

public int encodeRaw(byte[] bs,
 int pos)

Description copied from class: ACell

Writes this Cell's encoding to a byte array, excluding the tag byte.

Specified by:

encodeRaw in class ACell

Parameters:

bs - A byte array to which to write the encoding

pos - The offset into the byte array

Returns:

New position after writing

read

public static Receipt read(byte tag,
 Blob b,
 int pos)
                    throws BadFormatException

Throws:

BadFormatException

updateRefs

public Receipt updateRefs(IRefFunction func)

Description copied from class: ACell

Updates all child Refs in this object using the given function. This clears the currently cached Ref if an update occurred. This is because, presumably, a new Ref for this cell needs to be created. The function *must not* change the hash value of Refs, in order to ensure structural integrity of modified data structures. The implementation *should* re-attach any original encoding in order to prevent re-encoding or surplus hashing This is a building block for a very sneaky trick that enables use to do a lot of efficient operations on large trees of smart references. Must return the same object if no Refs are altered.

Overrides:

updateRefs in class ACell

Parameters:

func - Ref update function

Returns:

Cell with updated Refs

getRefCount

public int getRefCount()

Description copied from class: ACell

Gets the number of Refs contained within this Cell. This number is final / immutable for any given instance and is defined by the Cell encoding rules. Contained Refs may be either external or embedded.

Overrides:

getRefCount in class ACell

Returns:

The number of Refs in this Cell

getRef

public <R extends ACell> Ref<R> getRef(int i)

Description copied from class: ACell

Gets a numbered child Ref from within this Cell. WARNING: May need to convert to a canonical instance

Overrides:

getRef in class ACell

Type Parameters:

R - Type of referenced Cell

Parameters:

i - Index of ref to get

Returns:

The Ref at the specified index

isError

public boolean isError()