Interface Object

types/types.go:66–82

Object is an interface which represents values that can be loaded or stored in memory. The interface is mainly used as a constraint for generic type parameters.

//
// The interface is mainly used as a constraint for generic type parameters.
type Object[T any] interface {
	// Writes a human-readable representation of the object to w.
	FormatObject(w io.Writer, memory api.Memory, object []byte)
	// Loads and returns the object from the given byte slice. If the object
	// contains pointers it migh read them from the module memory passed as
	// first argument.
	LoadObject(memory api.Memory, object []byte) T
	// Stores the object to the given tye slice. If the object contains pointers
	// it might write them to the module memory passed as first argument (doing
	// so without writing to arbitrary location is difficult so this use case is
	// rather rare).
	StoreObject(memory api.Memory, object []byte)
	// Returns the size of the the object in bytes. The byte slices passed to
	// LoadObject and StoreObjects are guaranteed to be at least of the length
	// returned by this method.
	ObjectSize() int
}

// UnsafeLoadObject is a helper which may be used to implement the LoadObject
// method for object types which do not contain any inner pointers.