@haxall/haxall
    Preparing search index...

    Class TypedDict

    TypedDict wraps a dict that maps tags to statically typed fields. To use this API:

    1. Create subclass of TypedDict
    2. Annotate const instance fields with @TypedTag
    3. Create constructor with Dict and it-block callback
    4. Optionally create convenience factory that calls create

    The following coercions are supported:

    • Int field from Number tag
    • Duration field from Number tag
    • Bool field from Marker tag

    Example:

    const class ExampleRec : TypedDict
    {
    static new wrap(Dict d, |Str|? onErr := null) { create(ExampleRec#, d, onErr) }

    new make(Dict d, |This| f) : super(d) { f(this) }

    @TypedTag const Int limit := 99

    @TypedTag const Duration timeout := 3sec
    }

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Temp shim until we break backward compatibility

      Returns Ref

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that => 0
      this > that => >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3) => 1
      8.compare(8) => 0
      3 <=> 8 => -1 // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Get display string for dict or the given tag. If name is null, then return display text for the entire dict using Etc.dictToDis. If name is non-null then format the tag value using its appropiate toLocale method. If name is not defined by this dict, then return def.

      Parameters

      • Optionalname: string
      • Optionaldef: string

      Returns string

    • Iterate the wrapped dict tags

      Parameters

      • f: (arg0: JsObj, arg1: string) => void

      Returns void

    • Iterate the wrapped dict tags until callback returns non-null

      Parameters

      Returns JsObj

    • Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.

      Parameters

      Returns boolean

    • Get a tag from wrapped dict

      Parameters

      • n: string
      • Optionaldef: JsObj

      Returns JsObj

    • Return if wrapped dict has given tag

      Parameters

      • n: string

      Returns boolean

    • Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

      Returns number

    • Get the id tag as a Ref or raise CastErr/UnknownNameErr

      Returns Ref

    • Return if wrapped dict is empty

      Returns boolean

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • Create a new instance of this dict with the same names, but apply the specified closure to generate new values.

      Parameters

      Returns this

    • Wrapped dict for this instance

      Returns Dict

    • Return if wrapped dict is missing given tag

      Parameters

      • n: string

      Returns boolean

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Return string for debugging only

      Returns string

    • Trap on the wrapped dict

      Parameters

      Returns JsObj

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Factory to create for given type and dict to wrap. Invalid tag values are logged to the given callback if provided.

      Parameters

      • type: Type
      • meta: Dict
      • OptionalonErr: (arg0: string) => void

      Returns TypedDict

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void

    • Sub constructor.

      Parameters

      • meta: Dict
      • ...args: unknown[]

      Returns TypedDict