class Crystal::Macros::Def

Overview

A method definition.

Defined in:

compiler/crystal/macros.cr

Instance Method Summary

Instance methods inherited from class Crystal::Macros::ASTNode

!=(other : ASTNode) : BoolLiteral !=, ==(other : ASTNode) : BoolLiteral ==, class_name : StringLiteral class_name, column_number : StringLiteral | NilLiteral column_number, doc : StringLiteral doc, doc_comment : MacroId doc_comment, end_column_number : StringLiteral | NilLiteral end_column_number, end_line_number : StringLiteral | NilLiteral end_line_number, filename : StringLiteral | NilLiteral filename, id : MacroId id, is_a?(type : TypeNode) : BoolLiteral is_a?, line_number : StringLiteral | NilLiteral line_number, nil? : BoolLiteral nil?, raise(message) : NoReturn raise, stringify : StringLiteral stringify, symbolize : SymbolLiteral symbolize, warning(message : StringLiteral) : NilLiteral warning

Instance Method Detail

def abstract? : BoolLiteral #

Returns true is this method is declared as abstract, false otherwise.


[View source]
def accepts_block? : BoolLiteral #

Returns true if this method can be called with a block, false otherwise.


[View source]
def annotation(type : TypeNode) : Annotation | NilLiteral #

Returns the last Annotation with the given type attached to this method or NilLiteral if there are none.


[View source]
def annotations(type : TypeNode) : ArrayLiteral(Annotation) #

Returns an array of annotations with the given type attached to this method, or an empty ArrayLiteral if there are none.


[View source]
def annotations : ArrayLiteral(Annotation) #

Returns an array of all annotations attached to this method, or an empty ArrayLiteral if there are none.


[View source]
def args : ArrayLiteral(Arg) #

Returns the arguments of this method.


[View source]
def block_arg : Arg | Nop #

Returns the block argument, if any.


[View source]
def body : ASTNode #

Returns the body of this method.


[View source]
def double_splat : Arg | Nop #

Returns the double splat argument, if any.


[View source]
def free_vars : ArrayLiteral(MacroId) #

Returns the free variables of this method, or an empty ArrayLiteral if there are none.


[View source]
def name : MacroId #

Returns the name of this method.


[View source]
def receiver : ASTNode | Nop #

Returns the receiver (for example self) of this method definition, or Nop if not specified.


[View source]
def return_type : ASTNode | Nop #

Returns the return type of the method, if specified.


[View source]
def splat_index : NumberLiteral | NilLiteral #

Returns the index of the argument with a *splat, if any.


[View source]
def visibility : SymbolLiteral #

Returns the visibility of this def: :public, :protected or :private.


[View source]