عرض مصدر Ruby/String/index

<noinclude>{{DISPLAYTITLE:التابع <code>String.index</code> في روبي}}</noinclude>
[[تصنيف: Ruby]]
[[تصنيف: Ruby Method]]
[[تصنيف: Ruby String]]
يبحث التابع <code>index</code> عن سلسلة أو نمط مُحدد ضمن السلسلة النصية التي استدعيت معها، ثم يُعيد فهرس أول تطابق يعثر عليه. في حال عدم العثور على أي تطابق، فسيعيد التابع القيمة <code>nil</code>. يمكن تحديد موضع بدء البحث في السلسلة النصية المعطاة عبر تمرير فهرس المحرف الذي يراد بدء البحث عنه.
==البنية العامة==
<syntaxhighlight lang="ruby">index(substring [, offset]) → integer or nil
index(regexp [, offset]) → integer or nil</syntaxhighlight>

== المعاملات ==

=== <code>substring</code> ===
[[Ruby/String|السلسلة]] المُراد البحث عنها ضمن السلسلة النصية المُعطاة.

=== <code>regexp</code> ===
[[Ruby/Regexp|التعبير النمطي]] المُراد البحث عنه ضمن السلسلة النصية المُعطاة.

=== <code>offset</code> ===
[[Ruby/Integer|عدد صحيح]] يُحدد موضع بداية البحث في السلسلة النصية المُعطاة.

==القيمة المعادة==
يُعاد [[Ruby/Integer|عدد صحيح]] يمثِّل فهرس أول تطابق يعثر عليه التابع، أو تُعاد القيمة <code>nil</code> في حال عدم العثور على أي تطابق. 

==أمثلة==
مثال على استعمال التابع <code>index</code>:
<syntaxhighlight lang="ruby">"hello".index('e')             #=> 1
"hello".index('lo')            #=> 3
"hello".index('a')             #=> nil
"hello".index(?e)              #=> 1
"hello".index(/[aeiou]/, -3)   #=> 4</syntaxhighlight>

==انظر أيضًا==
* المعامل <code>[[Ruby/String/5B-5D|[]]]</code>: يجلب محرفًا ذا فهرس محدد، أو جزءًا محددًا ببداية وطول، أو مجالًا محددًا ببداية ونهاية من السلسلة النصية التي استدعيت معه.

* التابع <code>[[Ruby/String/byteslice|byteslice]]</code>: يجلب محرفًا ذا فهرس محدد، أو جزءًا محددًا ببداية وطول، أو مجالًا محددًا ببداية ونهاية من السلسلة النصية التي استدعيت معه.

==مصادر==
*[http://ruby-doc.org/core-2.5.1/String.html#method-i-index قسم التابع index‎ في الصنف String في توثيق روبي الرسمي.]