Class MaybeValue

Represents a get operation returning a value that may not exist.

Hierarchy

LeafExpr
- MaybeValue

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MaybeValue(op: Op, type: TealType, immediateArgs?: (string | number | bigint)[], args?: Expr[]): MaybeValue

Overrides LeafExpr.constructor
- Defined in src/ast/MaybeValue.ts:16
Create a new MaybeValue.

Parameters
- op: Op
  
  The operation that returns values.
- type: TealType
  
  The type of the returned value.
- Optional immediateArgs: (string | number | bigint)[]
  
  (optional) Immediate arguments for the op. Defaults to None.
- Optional args: Expr[]
  
  (optional) Stack arguments for the op. Defaults to None.
Returns MaybeValue

Properties

args

args: Expr[]

immediateArgs

immediateArgs: (string | number | bigint)[]

op

op: Op

slotOk

slotOk: ScratchSlot

slotValue

slotValue: ScratchSlot

type

Methods

And

And(other: Expr): Expr

Inherited from LeafExpr.And
- Defined in src/ast/Expr.ts:105
Take the logical And of this expression and another one.

This expression must evaluate to uint64.

This is the same as using And() with two arguments.

Parameters
- other: Expr
Returns Expr

Or

Or(other: Expr): Expr

Inherited from LeafExpr.Or
- Defined in src/ast/Expr.ts:119
Take the logical Or of this expression and another one.

This expression must evaluate to uint64.

This is the same as using Or() with two arguments.

Parameters
- other: Expr
Returns Expr

add

add(other: Expr): BinaryExpr

Inherited from LeafExpr.add
- Defined in src/ast/Expr.ts:58
Parameters
- other: Expr
Returns BinaryExpr

and

and(other: Expr): BinaryExpr

Inherited from LeafExpr.and
- Defined in src/ast/Expr.ts:82
Parameters
- other: Expr
Returns BinaryExpr

eq

eq(other: Expr): BinaryExpr

Inherited from LeafExpr.eq
- Defined in src/ast/Expr.ts:50
Parameters
- other: Expr
Returns BinaryExpr

ge

ge(other: Expr): BinaryExpr

Inherited from LeafExpr.ge
- Defined in src/ast/Expr.ts:46
Parameters
- other: Expr
Returns BinaryExpr

gt

gt(other: Expr): BinaryExpr

Inherited from LeafExpr.gt
- Defined in src/ast/Expr.ts:38
Parameters
- other: Expr
Returns BinaryExpr

hasValue

hasValue(): ScratchLoad

- Defined in src/ast/MaybeValue.ts:44
Check if the value exists.

Returns ScratchLoad

1 if the value exists, otherwise 0.

invert

invert(): UnaryExpr

Inherited from LeafExpr.invert
- Defined in src/ast/Expr.ts:78
Returns UnaryExpr

le

le(other: Expr): BinaryExpr

Inherited from LeafExpr.le
- Defined in src/ast/Expr.ts:42
Parameters
- other: Expr
Returns BinaryExpr

lt

lt(other: Expr): BinaryExpr

Inherited from LeafExpr.lt
- Defined in src/ast/Expr.ts:34
Parameters
- other: Expr
Returns BinaryExpr

mod

mod(other: Expr): BinaryExpr

Inherited from LeafExpr.mod
- Defined in src/ast/Expr.ts:74
Parameters
- other: Expr
Returns BinaryExpr

mul

mul(other: Expr): BinaryExpr

Inherited from LeafExpr.mul
- Defined in src/ast/Expr.ts:66
Parameters
- other: Expr
Returns BinaryExpr

ne

ne(other: Expr): BinaryExpr

Inherited from LeafExpr.ne
- Defined in src/ast/Expr.ts:54
Parameters
- other: Expr
Returns BinaryExpr

or

or(other: Expr): BinaryExpr

Inherited from LeafExpr.or
- Defined in src/ast/Expr.ts:86
Parameters
- other: Expr
Returns BinaryExpr

sub

sub(other: Expr): BinaryExpr

Inherited from LeafExpr.sub
- Defined in src/ast/Expr.ts:62
Parameters
- other: Expr
Returns BinaryExpr

teal

teal(options: CompileOptions): CompiledExpr

Overrides LeafExpr.teal
- Defined in src/ast/MaybeValue.ts:58
Parameters
- options: CompileOptions
Returns CompiledExpr

toString

toString(): string

- Defined in src/ast/MaybeValue.ts:84
Returns string

truediv

truediv(other: Expr): BinaryExpr

Inherited from LeafExpr.truediv
- Defined in src/ast/Expr.ts:70
Parameters
- other: Expr
Returns BinaryExpr

typeOf

typeOf(): TealType

Overrides LeafExpr.typeOf
- Defined in src/ast/MaybeValue.ts:80
Returns TealType

value

value(): ScratchLoad

- Defined in src/ast/MaybeValue.ts:54
Get the value.

Returns ScratchLoad

the value will be returned if it exists. Otherwise, the zero value for this type will be returned (i.e. either 0 or an empty byte string, depending on the type).

xor

xor(other: Expr): BinaryExpr

Inherited from LeafExpr.xor
- Defined in src/ast/Expr.ts:90
Parameters
- other: Expr
Returns BinaryExpr

Generated using TypeDoc