الدالة Regex.find()‎ في Kotlin

تبحث الدالة find()‎ عن أول محرف متطابق مع التعبير النمطي الذي استُدعي معها في سلسلة المحارف الممرَّرة إليها. يمكن البحث في سلسلة المحارف المعطاة بأكملها، أو يمكن بدء عملية البحث عند محرف معين.

البنية العامة

actual fun find(
    input: CharSequence, 
    startIndex: Int = 0
): MatchResult?

تبحث الدالة find()‎ عن أول محرف متطابق مع التعبير النمطي الذي استُدعي معها في سلسلة المحارف input الممررة إليها. يمكن البحث في سلسلة المحارف المعطاة بأكملها، أو يمكن بدء عملية البحث عند المحرف ذي الفهرس startIndex. يجب ألا تقل قيمة المعامل startIndex عن القيمة 0 وألا تزيد عن القيمة input.length()‎.

المعاملات

input

سلسلة المحارف التي يراد جلب أول محرف متطابق من محارفها مع التعبير النمطي المعطى.

startIndex

عدد صحيح يحدد فهرس المحرف الذي يراد بدء عملية المطابقة عنده. القيمة الافتراضية له هي: 0؛ أي بدء عملية المطابقة عند المحرف الأول.

القيمة المعادة

يعاد أول محرف تطابق مع التعبير النمطي المعطى من سلسلة المحارف input. يجدر بالذكر أن عملية البحث عن المحرف المتطابق تبدأ من المحرف ذي الفهرس startIndex.

أمثلة

استعمال الدالة find()‎ لجلب أول رقم تطابق مع التعبير النمطي ‎-?\d+(\.\d+)?‎:

fun main(args: Array<String>) {
    val reg = """-?\d+(\.\d+)?""".toRegex()

    val matchResult = reg.find("aff4rb")

    print(matchResult?.value) // 4
}

انظر أيضًا

• الدالة containsMatchIn()‎: تتحقق إن كان بإمكان التعبير النمطي الذي استُدعي معها مطابقة محرفٍ واحدٍ على الأقل من سلسلة المحارف المُمرّرة إليه.
• الدالة findAll()‎: تبحث عن جميع المحارف المتطابقة مع التعبير النمطي الذي استُدعي معها في سلسلة المحارف الممرَّرة إليها. يمكن البحث في سلسلة المحارف المعطاة بأكملها، أو يمكن بدء عملية البحث عند محرف معين.
• الدالة matches()‎: تتحقق من مطابقة جميع محارف السلسلة الممررة إليها مع التعبير النمطي الذي استدعي معها. 
• الدالة replace()‎: تبدل سلسلة النصية معينة مكان كل تطابقات التعبير النمطي الذي استدعي معها في سلسلة المحارف المُمرّرة إليها أو سلسلة المحارف التي تعيدها الدالة الممررة إليها.

مصادر

• صفحة الدالة Regex.find()‎ في التوثيق الرسميّ للمكتبة القياسيّة في لغة Kotlin.