الدالة substring()‎ في Kotlin

تعيد الدالة substring()‎ جزءًا محددًا من السلسلة النصية أو سلسلة المحارف التي استُدعيت معها.

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

inline actual fun String.substring(startIndex: Int): String 

inline actual fun String.substring(
    startIndex: Int, 
    endIndex: Int
): String

fun String.substring(range: IntRange): String 

fun CharSequence.substring(range: IntRange): String

inline fun CharSequence.substring(
    startIndex: Int, 
    endIndex: Int = length
): String

تعيد الدالة substring()‎ جزءًا من السلسلة النصية التي استُدعيت عبرها والذي يبدأ عند الفهرس المُحدّد startIndex و يستمر إلى نهاية السلسلة النصية الأصلية.

تعيد الدالة substring()‎ جزءًا من السلسلة النصية التي استُدعيت عبرها والذي يبدأ عند الفهرس المُحدّد startIndex و ينتهي عند الفهرس المُحدّد endIndex(غير مُتضمّن).

تعيد الدالة substring()‎ جزءًا من سلسلة الحروف أو السلسلة النصية التي استُدعيت عبرها والمُحدد بمجال الفهارس المُمرّر range.

تعيد الدالة substring()‎ جزءًا من سلسلة الحروف التي استُدعيت عبرها والذي يبدأ عند الفهرس المُحدّد startIndex و ينتهي عند الفهرس المُحدّد endIndex(غير مُتضمّن). القيمة الافتراضية للوسيط endIndex هي طول سلسلة الحروف الأصلية.

يُلاحَظ وجود الكلمة المفتاحية inline للدلالة على أن هذه الدالة مباشرة، وللمزيد من التفاصيل راجع توثيق الدوال المباشرة (inline functions).

المعاملات

startIndex

عدد صحيح يشير إلى فهرس العنصر الذي يمثل بداية المجال المراد جلبه.

endIndex

عدد صحيح يشير إلى فهرس العنصر الذي يمثل نهاية المجال المراد جلبه (لا يدخل هذا المحرف ضمن المجال). إن لم يعطَ هذا المعامل، فستكون نهاية الجزء المراد جلبه هي نهاية سلسلة المحارف أو السلسلة النصية المعطاة.

range

مجال من النوع IntRange يحدد الجزء المراد جلبه من سلسلة المحارف المعطاة.

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

تعاد سلسلة نصية تحوي الجزء المقتطع من سلسلة المحارف المعطاة المحدد بالمعامل startIndex والمعامل endIndex، أو بالمجال range. 

أمثلة

مثالٌ على استعمال الدالة ()substring:

fun main(args: Array<String>) {
    val str = "wiki.hsoub.com"

    println(str.substring(5..9)) // hsoub
    println(str.substring(5, 10)) // hsoub
}

انظر أيضًا

• substringAfter()‎: تعيد الدالة substringAfter()‎ جزءًا من السلسلة النصية التي استُدعيت عبرها والمُتواجد بعد أول ظهور للمُحدِّد delimiter، إن لم تكن السلسلة النصية الأصلية تحتوي delimiter، فستعيد القيمة المُمرّرة missingDelimiterValue، والتي قيمتها الافتراضية هي السلسلة النصية الأصلية. 
• substringBefore()‎: تعيد الدالة substringBefore()‎ جزءًا من السلسلة النصية التي استُدعيت عبرها والمُتواجد قبل أول ظهور للمُحدِّد delimiter، إن لم تكن السلسلة النصية الأصلية تحتوي delimiter، فستعيد القيمة المُمرّرة missingDelimiterValue، والتي قيمتها الافتراضية هي السلسلة النصية الأصلية. 

• removeSuffix()‎: إن كانت السلسلة النصية أو سلسلة الحروف التي استٌدعيت عبرها الدالة removeSuffix()‎ تنتهي باللاحقة suffix فستعيد سلسلة نصية أو سلسلة حروف جديدة مع حذف تلك اللاحقة، وإلا فستعيد السلسلة النصية أو سلسلة الحروف كما هي. 
• slice()‎: تعيد الدالة slice()‎ سلسلة حروف أو سلسلة نصية جديدة تحتوي الحروف التي تنتمي فهارسها إلى الوسيط المُمرر. 

مصادر

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