عرض مصدر Ruby/Proc/arity

{{DISPLAYTITLE:التابع <code>Proc.arity</code> في روبي}}
يُعيد التابع <code>arity</code> عدد الوسائط الإلزاميَّة في الكائن <code>proc</code> الذي استدعي معه. إذا عُرِّفت الكتلة (block) من دون وسائط، فسيُعيد التابع القيمة <code>0</code>. إذا عُرِّفت الكتلة مع عدد محدَّد <code>n</code> من الوسائط، فسيُعيد التابع ذلك العدد <code>n</code>. إذا كان للكتلة وسائط اختيارية، فسيُعيد التابع <code>1-n-</code>، إذ يمثِّل <code>n</code> عدد الوسائط الإلزامية، باستثناء الكتل التي ليست من النوع <code>lambda</code> والتي تمتلك عددًا محدودًا من الوسائط الاختيارية؛ في هذه الحالة الأخيرة، يُعيد التابع العدد <code>n</code>. تُعتبر وسائط الكلمة المفتاحية (keyword argument) وسيطًا إضافيًّا واحدًا، ويصبح ذلك الوسيط إلزاميًّا إذا كان أيٌّ من وسائط الكلمة المفتاحية إلزاميًّا. تعريف كتلة <code>proc</code> من دون وسائط مشابه لتعريف كتلة على أنَّ <code>||</code> هي وسائطها.

== البنية العامة ==
<syntaxhighlight lang="ruby">
arity → integer
</syntaxhighlight>

== القيم المعادة ==
تُعاد القيمة <code>0</code> إذا عُرِّفت الكتلة من دون وسائط، أو يُعاد العدد <code>n</code> إذا عُرِّفت الكتلة مع عدد محدَّد <code>n</code> من الوسائط، أو يُعاد العدد <code>1-n-</code> إذا كان للكتلة وسائط اختيارية، إذ يمثِّل <code>n</code> عدد الوسائط الإلزامية. باستثناء الكتل التي ليست من النوع <code>lambda</code> والتي تمتلك عدد محدود من الوسائط الاختيارية، يُعاد عندها العدد <code>n</code>.

== أمثلة ==
مثالٌ عن استخدام التابع <code>arity</code>:<syntaxhighlight lang="ruby">
proc {}.arity                  #=>  0
proc { || }.arity              #=>  0
proc { |a| }.arity             #=>  1
proc { |a, b| }.arity          #=>  2
proc { |a, b, c| }.arity       #=>  3
proc { |*a| }.arity            #=> -1
proc { |a, *b| }.arity         #=> -2
proc { |a, *b, c| }.arity      #=> -3
proc { |x:, y:, z:0| }.arity   #=>  1
proc { |*a, x:, y:0| }.arity   #=> -2

proc   { |a=0| }.arity         #=>  0
lambda { |a=0| }.arity         #=> -1
proc   { |a=0, b| }.arity      #=>  1
lambda { |a=0, b| }.arity      #=> -2
proc   { |a=0, b=0| }.arity    #=>  0
lambda { |a=0, b=0| }.arity    #=> -1
proc   { |a, b=0| }.arity      #=>  1
lambda { |a, b=0| }.arity      #=> -2
proc   { |(a, b), c=0| }.arity #=>  1
lambda { |(a, b), c=0| }.arity #=> -2
proc   { |a, x:0, y:0| }.arity #=>  1
lambda { |a, x:0, y:0| }.arity #=> -2

</syntaxhighlight>

== انظر أيضًا ==
* التابع <code>[[Ruby/Proc/binding|binding]]</code>: يُعيد الرَّبط الموافق للكائن <code>Proc</code> الذي استدعي معه.
* التابع <code>[[Ruby/Proc/curry|curry]]</code>: يُعيد كتلة <code>proc</code> مقسَّمة.
* التابع <code>[[Ruby/Proc/to s|to_s]]</code>: يُعيد المُعرِّف الفريد لكتلة <code>proc</code> محدّدة بالتزامن مع إشارة لمكان تعريف هذه الكتلة.
* التابع <code>[[Ruby/Proc/parameters|parameters]]</code>: يُعيد معلوماتٍ عن معاملات كتلة محدَّدة من النوع <code>proc</code>.
* التابع <code>[[Ruby/Proc/source location|source_location]]</code>: يُعيد اسم ملف روبي المصدري ورقم السَّطر الحاوي على كتلة <code>proc</code>محدَّدة.

== مصادر ==
* [http://ruby-doc.org/core-2.5.1/Proc.html#method-i-arity صفحة التابع arity في الصنف Proc في توثيق روبي الرسمي.]
[[تصنيف:Ruby]]
[[تصنيف:Ruby Method]]
[[تصنيف:Ruby Proc]]