Package convex.core.lang.ops

Class Def<T extends ACell>

java.lang.Object
convex.core.data.AObject
convex.core.data.ACell
convex.core.lang.AOp<T>
convex.core.lang.ops.Def<T>
Type Parameters:
T - Type of defined value
All Implemented Interfaces:
IValidated, IWriteable
public class Def<T extends ACell> extends AOp<T>
Op that creates a definition in the current environment. Def may optionally have symbolic metadata attached to the symbol.

  • Method Details

    • create

      public static <T extends ACell> Def<T> create​(ACell key, Ref<AOp<T>> op)

    • create

      public static <T extends ACell> Def<T> create​(Syntax key, Ref<AOp<T>> op)

    • create

      public static <T extends ACell> Def<T> create​(Syntax key, AOp<T> op)

    • create

      public static <T extends ACell> Def<T> create​(Symbol key, AOp<T> op)

    • create

      public static <T extends ACell> Def<T> create​(ACell key, AOp<T> op)

    • create

      public static <T extends ACell> Def<T> create​(String key, AOp<T> op)

    • execute

      public <I extends ACell> Context<T> execute​(Context<I> context)
      Description copied from class: AOp
      Executes this op with the given context. Must preserve depth unless an exceptional is returned.
      Specified by:
      execute in class AOp<T extends ACell>
      Type Parameters:
      I - Type of Context
      Parameters:
      context - Initial Context
      Returns:
      The updated Context after executing this operation

    • 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.
      Specified by:
      getRefCount in class ACell
      Returns:
      The number of Refs in this Cell

    • getRef

      public Ref<AOp<T>> getRef​(int i)
      Description copied from class: ACell
      Gets a numbered child Ref from within this Cell.
      Overrides:
      getRef in class ACell
      Parameters:
      i - Index of ref to get
      Returns:
      The Ref at the specified index

    • updateRefs

      public Def<T> updateRefs​(IRefFunction func)
      Description copied from class: ACell
      Updates all Refs in this object using the given function. The function *must not* change the hash value of Refs, in order to ensure structural integrity of modified data structures. 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.
      Specified by:
      updateRefs in class AOp<T extends ACell>
      Parameters:
      func - Ref update function
      Returns:
      Cell with updated Refs

    • print

      public boolean print​(BlobBuilder sb, long limit)
      Description copied from class: AObject
      Prints this Object to a readable String Representation. SECURITY: Must halt and return false in O(1) time if limit of printing is exceeded otherwise DoS attacks may be possible.
      Specified by:
      print in class AObject
      Parameters:
      sb - BlobBuilder to append to
      limit - Limit of printing in string bytes
      Returns:
      True if fully printed within limit, false otherwise

    • opCode

      public byte opCode()
      Description copied from class: AOp
      Returns the opcode for this op
      Specified by:
      opCode in class AOp<T extends ACell>
      Returns:
      Opcode as a byte

    • encodeRaw

      public int encodeRaw​(byte[] bs, int pos)
      Description copied from class: AOp
      Writes the raw data for this Op to the specified bytebuffer. Assumes Op tag and opcode already written.
      Specified by:
      encodeRaw in class AOp<T extends ACell>
      Parameters:
      bs - Byte array to write to
      pos - Position to write in byte array
      Returns:
      The updated position

    • estimatedEncodingSize

      public int estimatedEncodingSize()
      Description copied from interface: IWriteable
      Estimate the encoded data size for this Cell. Used for quickly sizing buffers. Implementations should try to return a size that is likely to contain the entire object when represented in binary format, including the tag byte.
      Specified by:
      estimatedEncodingSize in interface IWriteable
      Overrides:
      estimatedEncodingSize in class AOp<T extends ACell>
      Returns:
      The estimated size for the binary representation of this object.

    • read

      public static <T extends ACell> Def<T> read​(ByteBuffer b) throws BadFormatException
      Throws:
      BadFormatException

    • 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