class Crystal::Def

• Crystal::Def
• Crystal::ASTNode
• Reference
• Object

Overview

A method definition.

'def' [ receiver '.' ] name
  body
'end'

| 'def' [ receiver '.' ] name '(' [ arg [ ',' arg ]* ] ')' body 'end'

Included Modules

• Crystal::Annotatable
• Crystal::HookExpansionsContainer

Direct Known Subclasses

• Crystal::External

Defined in:

Constructors

• .new(name : String, args : Array(Crystal::Arg) = [] of Arg, body = nil, receiver : Crystal::ASTNode | Nil = nil, block_arg : Nil | Crystal::Arg = nil, return_type : Crystal::ASTNode | Nil = nil, macro_def : Bool = false, block_arity : Int32 | Nil = nil, abstract __arg26 : Bool = false, splat_index : Int32 | Nil = nil, double_splat : Nil | Crystal::Arg = nil, free_vars : Nil | Array(String) = nil)

Class Method Summary

• .argless_initialize(instance_type)
• .argless_new(instance_type)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #abi_info=(abi_info : Bool)
• #abi_info? : Bool
• #abstract=(abstract __arg0 : Bool)
• #abstract? : Bool
• #accept_children(visitor)
• #add_special_var(name)
• #always_inline=(always_inline : Bool)

  true if this def has the @[AlwaysInline] annotation

• #always_inline? : Bool

  true if this def has the @[AlwaysInline] annotation

• #args : Array(Arg)
• #args=(args : Array(Arg))
• #assigns_special_var=(assigns_special_var : Bool)
• #assigns_special_var? : Bool
• #autogenerated?
• #block_arg : Arg | Nil
• #block_arg=(block_arg : Arg | Nil)
• #block_arity : Int32 | Nil

  Number of block arguments accepted by this method.

• #block_arity=(block_arity : Int32 | Nil)

  Number of block arguments accepted by this method.

• #block_nest : Int32
• #block_nest=(block_nest : Int32)
• #body : ASTNode
• #body=(body : ASTNode)
• #c_calling_convention : Bool?
• #c_calling_convention=(c_calling_convention : Bool | Nil)
• #c_calling_convention?

  Returns self as an External if this Def is an External that must respect the C calling convention.

• #call_convention
• #calls_initialize=(calls_initialize : Bool)
• #calls_initialize? : Bool
• #calls_previous_def=(calls_previous_def : Bool)
• #calls_previous_def? : Bool
• #calls_super=(calls_super : Bool)
• #calls_super? : Bool
• #captured_block=(captured_block : Bool)
• #captured_block? : Bool
• #clone_without_location
• #closure=(closure : Bool)
• #closure? : Bool
• #doc : String | Nil

  Returns the doc comment attached to this node.

• #doc=(doc : String | Nil)
• #double_splat : Arg | Nil
• #double_splat=(double_splat : Arg | Nil)
• #expand_default_arguments(program, args_size, named_args = nil)
• #expand_new_default_arguments(instance_type, args_size, named_args)
• #expand_new_from_initialize(instance_type)
• #expand_new_signature_from_initialize(instance_type)
• #fill_body_from_initialize(instance_type)
• #free_var?(node : Path)
• #free_var?(any)
• #free_vars : Array(String) | Nil
• #free_vars=(free_vars : Array(String) | Nil)
• #freeze_type : Type | Nil
• #freeze_type=(freeze_type : Type | Nil)
• #has_any_args?
• #hash(hasher)

  See Object#hash(hasher)

• #interpret(method : String, args : Array(ASTNode), named_args : Hash(String, ASTNode) | Nil, block : Crystal::Block | Nil, interpreter : Crystal::MacroInterpreter, name_loc : Location | Nil)
• #llvm_intrinsic?
• #macro_def=(macro_def : Bool)
• #macro_def? : Bool
• #macro_owner
• #macro_owner=(macro_owner : Crystal::Type | Nil)
• #macro_owner? : Crystal::Type?
• #mangled_name(program, self_type)
• #map_type(type)
• #match(objects, &)

  Yields arg, arg_index, object, object_index corresponding to arguments matching the given objects, taking into account this def's splat index.

• #min_max_args_sizes

  Returns the minimum and maximum number of positional arguments that must be passed to this method, assuming positional parameters are not matched by named arguments.

• #naked=(naked : Bool)

  true if this def has the @[Naked] annotation

• #naked? : Bool

  true if this def has the @[Naked] annotation

• #name : String
• #name=(name : String)
• #name_location : Location | Nil
• #name_location=(name_location : Location | Nil)
• #name_size
• #new=(new : Bool)

  Is this a .new method that was expanded from an initialize?

• #new? : Bool

  Is this a .new method that was expanded from an initialize?

• #next : Def | Nil
• #next=(next __arg0 : Def | Nil)
• #no_inline=(no_inline : Bool)

  true if this def has the @[NoInline] annotation

• #no_inline? : Bool

  true if this def has the @[NoInline] annotation

• #original_name
• #original_name=(original_name : String | Nil)

  Name of the original def if this def has been expanded (default arguments)

• #original_name? : String | Nil

  Name of the original def if this def has been expanded (default arguments)

• #original_owner : Type
• #original_owner=(original_owner : Type)
• #original_owner? : Type | Nil
• #owner : Type
• #owner=(owner : Type)
• #owner? : Type | Nil
• #pretty_print(pp) : Nil
• #previous : DefWithMetadata | Nil
• #previous=(previous : DefWithMetadata | Nil)
• #proc_c_calling_convention?
• #raises=(raises : Bool)
• #raises? : Bool
• #receiver : ASTNode | Nil
• #receiver=(receiver : ASTNode | Nil)
• #return_type : ASTNode | Nil
• #return_type=(return_type : ASTNode | Nil)
• #returns_twice=(returns_twice : Bool)

  true if this def has the @[ReturnsTwice] annotation

• #returns_twice? : Bool

  true if this def has the @[ReturnsTwice] annotation

• #self_closured=(self_closured : Bool)
• #self_closured? : Bool
• #self_restriction_type : Type | Nil

  Used to override the meaning of self in restrictions

• #self_restriction_type=(self_restriction_type : Type | Nil)

  Used to override the meaning of self in restrictions

• #short_reference
• #special_vars : Set(String) | Nil
• #special_vars=(special_vars : Set(String) | Nil)
• #splat_index : Int32 | Nil
• #splat_index=(splat_index : Int32 | Nil)
• #target_cpu : String | Nil

  Set to the value of the @[TargetFeature(cpu: "apple-m4")] annotation

• #target_cpu=(target_cpu : String | Nil)

  Set to the value of the @[TargetFeature(cpu: "apple-m4")] annotation

• #target_features : String | Nil

  Set to the value of the @[TargetFeature("+sve,+sve2")] annotation

• #target_features=(target_features : String | Nil)

  Set to the value of the @[TargetFeature("+sve,+sve2")] annotation

• #to_json(builder : JSON::Builder)
• #uses_block_arg=(uses_block_arg : Bool)
• #uses_block_arg? : Bool
• #varargs?
• #vars : MetaVars | Nil
• #vars=(vars : MetaVars | Nil)
• #visibility : Crystal::Visibility
• #visibility=(visibility : Crystal::Visibility)
• #yield_vars : Array(Var) | Nil
• #yield_vars=(yield_vars : Array(Var) | Nil)

Constructor Detail

Class Method Detail

Instance Method Detail