Class StructDefinition

Hierarchy (view full)

ASTNodeWithChildren<StructuredDocumentation | VariableDeclaration>
- StructDefinition

Constructors

constructor

new StructDefinition(id, src, name, scope, visibility, members, documentation?, nameLocation?, raw?): StructDefinition
Parameters
- id: number
- src: string
- name: string
- scope: number
- visibility: string
- members: Iterable<VariableDeclaration>
- Optional documentation: string | StructuredDocumentation
- Optional nameLocation: string
- Optional raw: any
Returns StructDefinition
Overrides ASTNodeWithChildren.constructor
- Defined in src/ast/implementation/declaration/struct_definition.ts:40

Properties

`Optional` context

context?: ASTContext

Current tree context of the node

`Optional` danglingDocString

danglingDocString?: string

`Optional` docString

docString?: string

id

id: number

Unique identifier number for the node in the tree context

name

name: string

The name of the struct

`Optional` nameLocation

nameLocation?: string

The source range for name string

`Optional` parent

parent?: ASTNode

The AST node that is containing current node

`Optional` raw

raw?: any

Raw original Solc AST node that was used to create current node.

scope

scope: number

Node id of scoped contract or source unit

src

src: string

Source mapping data corresponting to the AST node.

The value has format start:length:sourceIndex:

start is the starting index of the corresponding code fragment substring in the source string;
length is the length of corresponding code fragment substring;
sourceIndex is the index number of the source unit (file), that contains the AST node.

To get parsed values, use sourceInfo accessor.

visibility

visibility: string

Struct visibility

Accessors

canonicalName

get canonicalName(): string
Canonical name (or qualified name), e.g. DefiningContract.SomeStruct

Returns string
- Defined in src/ast/implementation/declaration/struct_definition.ts:67

children

get children(): readonly T[]
Returns children nodes of the current node

Returns readonly T[]
Inherited from ASTNodeWithChildren.children
- Defined in src/ast/ast_node.ts:353

danglingDocumentation

get danglingDocumentation(): undefined | string | StructuredDocumentation
Optional documentation that is dangling in the source fragment, that is after end of last child and before the end of the current node.

It is:
- Is undefined when not detected.
- Is type of string for compatibility reasons.
Returns undefined | string | StructuredDocumentation
- Defined in src/ast/implementation/declaration/struct_definition.ts:93
set danglingDocumentation(value): void
Parameters
- value: undefined | string | StructuredDocumentation
Returns void
- Defined in src/ast/implementation/declaration/struct_definition.ts:97

documentation

get documentation(): undefined | string | StructuredDocumentation
Optional documentation appearing above the contract definition:
- Is undefined when not specified.
- Is type of string when specified and compiler version is older than 0.6.3.
- Is instance of StructuredDocumentation when specified and compiler version is 0.6.3 or newer.
Returns undefined | string | StructuredDocumentation
- Defined in src/ast/implementation/declaration/struct_definition.ts:77
set documentation(value): void
Parameters
- value: undefined | string | StructuredDocumentation
Returns void
- Defined in src/ast/implementation/declaration/struct_definition.ts:81

firstChild

get firstChild(): undefined | ASTNode
Returns the first immediate child of the node, or undefined if the node has no children.

Returns undefined | ASTNode
Inherited from ASTNodeWithChildren.firstChild
- Defined in src/ast/ast_node.ts:105

lastChild

get lastChild(): undefined | ASTNode
Returns the last immediate child of the node, or undefined if the node has no children.

Returns undefined | ASTNode
Inherited from ASTNodeWithChildren.lastChild
- Defined in src/ast/ast_node.ts:113

nextSibling

get nextSibling(): undefined | ASTNode
Returns the node immediately following the current one in its parent's children.

Returns undefined if the current node is the last child in its parent's children.

Returns undefined | ASTNode
Inherited from ASTNodeWithChildren.nextSibling
- Defined in src/ast/ast_node.ts:142

previousSibling

get previousSibling(): undefined | ASTNode
Returns the node immediately preceding the current one in its parent's children.

Returns undefined if the current node is the first child in its parent's children.

Returns undefined | ASTNode
Inherited from ASTNodeWithChildren.previousSibling
- Defined in src/ast/ast_node.ts:124

requiredContext

get requiredContext(): ASTContext
Returns current node AST context. Throws an error if no context is set.

Returns ASTContext
Inherited from ASTNodeWithChildren.requiredContext
- Defined in src/ast/ast_node.ts:86

root

get root(): ASTNode
Returns most parent node in tree hierarchy

Returns ASTNode
Inherited from ASTNodeWithChildren.root
- Defined in src/ast/ast_node.ts:156

sourceInfo

get sourceInfo(): SourceLocation
Returns parsed parts of the src property value

Returns SourceLocation
Inherited from ASTNodeWithChildren.sourceInfo
- Defined in src/ast/ast_node.ts:169

type

get type(): string
Type of the AST node

Returns string
Inherited from ASTNodeWithChildren.type
- Defined in src/ast/ast_node.ts:79

vMembers

get vMembers(): readonly VariableDeclaration[]
Members of the struct

Returns readonly VariableDeclaration[]
- Defined in src/ast/implementation/declaration/struct_definition.ts:104

vScope

get vScope(): SourceUnit | ContractDefinition
Reference to its scoped contract or source unit

Returns SourceUnit | ContractDefinition
- Defined in src/ast/implementation/declaration/struct_definition.ts:113
set vScope(value): void
Parameters
- value: SourceUnit | ContractDefinition
Returns void
- Defined in src/ast/implementation/declaration/struct_definition.ts:117

Methods

acceptChildren

acceptChildren(): void
Sets parent to the current node for each of the accessible children node.

Returns void
Inherited from ASTNodeWithChildren.acceptChildren
- Defined in src/ast/ast_node.ts:70

appendChild

appendChild(node): VariableDeclaration | StructuredDocumentation
Parameters
- node: VariableDeclaration | StructuredDocumentation
Returns VariableDeclaration | StructuredDocumentation
Inherited from ASTNodeWithChildren.appendChild
- Defined in src/ast/ast_node.ts:371

extractSourceFragment

extractSourceFragment(source): Uint8Array
Extracts and returns substring from source, that corresponds to src property value of the current node.

In other words, returns corresponding code fragment substring.
Parameters
- source: Uint8Array
Returns Uint8Array
Inherited from ASTNodeWithChildren.extractSourceFragment
- Defined in src/ast/ast_node.ts:331

getChildren

getChildren(inclusive?): ASTNode[]
Parameters
- inclusive: boolean = false
Returns ASTNode[]
Inherited from ASTNodeWithChildren.getChildren
- Defined in src/ast/ast_node.ts:197

getChildrenBySelector

getChildrenBySelector<T>(selector, inclusive?): T[]
Type Parameters
- T extends ASTNode
Parameters
- selector: ASTNodeSelector
- inclusive: boolean = true
Returns T[]
Inherited from ASTNodeWithChildren.getChildrenBySelector
- Defined in src/ast/ast_node.ts:212

getChildrenByType

getChildrenByType<T>(type, inclusive?): T[]
Type Parameters
- T extends ASTNode
Parameters
- type: ASTNodeConstructor<T>
- inclusive: boolean = false
Returns T[]
Inherited from ASTNodeWithChildren.getChildrenByType
- Defined in src/ast/ast_node.ts:229

getChildrenByTypeString

getChildrenByTypeString<T>(typeString, inclusive?): T[]
Type Parameters
- T extends ASTNode
Parameters
- typeString: string
- inclusive: boolean = false
Returns T[]
Inherited from ASTNodeWithChildren.getChildrenByTypeString
- Defined in src/ast/ast_node.ts:233

getClosestParentBySelector

getClosestParentBySelector<T>(selector): undefined | T
Type Parameters
- T extends ASTNode
Parameters
- selector: ASTNodeSelector
Returns undefined | T
Inherited from ASTNodeWithChildren.getClosestParentBySelector
- Defined in src/ast/ast_node.ts:247

getClosestParentByType

getClosestParentByType<T>(type): undefined | T
Type Parameters
- T extends ASTNode
Parameters
- type: ASTNodeConstructor<T>
Returns undefined | T
Inherited from ASTNodeWithChildren.getClosestParentByType
- Defined in src/ast/ast_node.ts:261

getClosestParentByTypeString

getClosestParentByTypeString<T>(typeString): undefined | T
Type Parameters
- T extends ASTNode
Parameters
- typeString: string
Returns undefined | T
Inherited from ASTNodeWithChildren.getClosestParentByTypeString
- Defined in src/ast/ast_node.ts:265

getFieldValues

getFieldValues(): Map<string, any>
Returns Map<string, any>
Inherited from ASTNodeWithChildren.getFieldValues
- Defined in src/ast/ast_node.ts:291

getGettersValues

getGettersValues(): Map<string, any>
Returns Map<string, any>
Inherited from ASTNodeWithChildren.getGettersValues
- Defined in src/ast/ast_node.ts:295

getParents

getParents(): ASTNode[]
Returns ASTNode[]
Inherited from ASTNodeWithChildren.getParents
- Defined in src/ast/ast_node.ts:237

getParentsBySelector

getParentsBySelector<T>(selector): T[]
Type Parameters
- T extends ASTNode
Parameters
- selector: ASTNodeSelector
Returns T[]
Inherited from ASTNodeWithChildren.getParentsBySelector
- Defined in src/ast/ast_node.ts:269

print

print(depth?): string
Returns string representation of the node properties.
Parameters
- depth: number = 0
  The number of children node levels to output
Returns string
Inherited from ASTNodeWithChildren.print
- Defined in src/ast/ast_node.ts:287

removeChild

removeChild(node): VariableDeclaration | StructuredDocumentation
Parameters
- node: VariableDeclaration | StructuredDocumentation
Returns VariableDeclaration | StructuredDocumentation
Inherited from ASTNodeWithChildren.removeChild
- Defined in src/ast/ast_node.ts:357

replaceChild

replaceChild(newNode, oldNode): VariableDeclaration | StructuredDocumentation
Parameters
- newNode: VariableDeclaration | StructuredDocumentation
- oldNode: VariableDeclaration | StructuredDocumentation
Returns VariableDeclaration | StructuredDocumentation
Inherited from ASTNodeWithChildren.replaceChild
- Defined in src/ast/ast_node.ts:409

walk

walk(callback): void
Parameters
- callback: ASTNodeCallback
Returns void
Inherited from ASTNodeWithChildren.walk
- Defined in src/ast/ast_node.ts:173

walkChildren

walkChildren(callback): void
Parameters
- callback: ASTNodeCallback
Returns void
Inherited from ASTNodeWithChildren.walkChildren
- Defined in src/ast/ast_node.ts:179

walkParents

walkParents(callback): void
Parameters
- callback: ASTNodeCallback
Returns void
Inherited from ASTNodeWithChildren.walkParents
- Defined in src/ast/ast_node.ts:187

Class StructDefinition

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns StructDefinition

Properties

Optional context

Optional danglingDocString

Optional docString

id

name

Optional nameLocation

Optional parent

Optional raw

scope

src

visibility

Accessors

canonicalName

Returns string

children

Returns readonly T[]

danglingDocumentation

Returns undefined | string | StructuredDocumentation

Parameters

Returns void

documentation

Returns undefined | string | StructuredDocumentation

Parameters

Returns void

firstChild

Returns undefined | ASTNode

lastChild

Returns undefined | ASTNode

nextSibling

Returns undefined | ASTNode

previousSibling

Returns undefined | ASTNode

requiredContext

Returns ASTContext

root

Returns ASTNode

sourceInfo

Returns SourceLocation

type

Returns string

vMembers

Returns readonly VariableDeclaration[]

vScope

Returns SourceUnit | ContractDefinition

Parameters

Returns void

Methods

acceptChildren

Returns void

appendChild

Parameters

Returns VariableDeclaration | StructuredDocumentation

extractSourceFragment

Parameters

Returns Uint8Array

getChildren

Parameters

Returns ASTNode[]

getChildrenBySelector

Type Parameters

Parameters

Returns T[]

getChildrenByType

Type Parameters

Parameters

Returns T[]

getChildrenByTypeString

Type Parameters

`Optional` context

`Optional` danglingDocString

`Optional` docString

`Optional` nameLocation

`Optional` parent

`Optional` raw