Kotlin/kotlin.text/trimIndent

تبحث الدالة trimIndent()‎ عن إزاحة دنوية (minimal indent) مشتركة بين جميع أسطر السلسلة النصية التي استُدعيت عبرها، ثم تمحوها من كل الأسطر، كما تمحو السطر الأول والأخير إن كانا بيضاوين (blanks)، أي مُكوّنان من مسافات بيضاء (whitespaces).

تذكّر أن الأسطر البيضاء لا تؤثر في رصد الإزاحة الدنوية.

في حال كان هناك سطر غير أبيض وليس في بدايته مسافات بيضاء، حينها ستكون الإزاحة الدنوية معدومة، وهذا يعني أنّ الدالة لن تغير الإزاحة.

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

fun String.trimIndent(): String

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

سلسلة نصية.

أمثلة

استخدام الدالة ()trimIndent مع سلسلة نصية

تستدعي الشيفرة الآتية الدالة ()trimIndent عبر سلسلة نصية وتمرّر القيمة المُعادة إلى المتغير withoutIndent، ثم تطبع الناتج:

fun main(args: Array<String>) {
val withoutIndent =
"""
            ABC
            123
            456
        """.trimIndent()
    
println(withoutIndent) // ABC\n123\n456
}

انظر أيضًا

• trimEnd()‎: تعيد الدالة trimEnd()‎ جزءًا من سلسلة الحروف التي استُدعيت عبرها بعد حذف الأحرف الأخيرة التي تحقق الشرط المنطقي المُحدّد predicate.
• trim()‎: تعيد الدالة trim()‎ جزءًا من سلسلة الحروف أو السلسلة النصية التي استُدعيت عبرها بعد حذف الأحرف الأولى والأخيرالتي تحقق الشرط المنطقي المُحدّد predicate.

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

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

مصادر

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