Kotlin/kotlin.text/trimMargin

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

لا تؤثر الدالةُ في الاسطر التي لا تحتوي marginPrefix، باستثناء الأسطر البيضاء الأولى والأخيرة.

marginPrefix سلسلة نصية غير بيضاء والذي يُستخدم كمحدد للهامش، قيمته الابتدائية هي |.

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

fun String.trimMargin(marginPrefix: String = "|"): String

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

سلسلة نصية.

أمثلة

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

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

fun main(args: Array<String>) {
val withoutMargin1 = """ABC
                |123
                |456""".trimMargin()
println(withoutMargin1) // ABC\n123\n456

val withoutMargin2 = """
    #XYZ
    #foo
    #bar
""".trimMargin("#")
println(withoutMargin2) // XYZ\nfoo\nbar
}

انظر أيضًا

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

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

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

مصادر

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