الدالة text.format()‎ في لغة Kotlin

يختلف سلوك حسب نوع وعدد الوسائط المُمرّرة إليها (انظر فقرة البنية العامة).

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

inline fun String.format(vararg args: Any?): String

بيئة التشغيل المطلوبة: JVM تستخدم الدالةformat()‎ السلسلة النصية التي استُدعيت عبرها كقالب توضيب (format string) وتعيد سلسلة نصية بتعويض الوسيط المحدد باستخدام الإعدادات المحلية الابتدائية.

inline fun String.Companion.format(
    format: String, 
    vararg args: Any?
): String

بيئة التشغيل المطلوبة: JVM تستخدم الدالةformat()‎ السلسلة النصية المُمرّرة format كقالب توضيب (format string) وتعيد سلسلة نصية بتعويض الوسيط المحدد باستخدام الإعدادات المحلية الابتدائية.

inline fun String.format(
    locale: Locale, 
    vararg args: Any?
): String

بيئة التشغيل المطلوبة: JVM تستخدم الدالةformat()‎ السلسلة النصية التي استُدعيت عبرها كقالب توضيب (format string) وتعيد سلسلة نصية بتعويض الوسيط المحدد باستخدام الإعدادات المحلية المُمرّرة locale.

inline fun String.Companion.format(
    locale: Locale, 
    format: String, 
    vararg args: Any?
): String

بيئة التشغيل المطلوبة: JVM

تستخدم الدالةformat()‎ السلسلة النصية المُمرّرة format كقالب توضيب (format string) وتعيد سلسلة نصية بتعويض الوسيط المحدد باستخدام الإعدادات المحلية المُمرّرة locale.

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

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

سلسلة نصية.

أمثلة

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

تعرِّف الشيفرة الآتية سلسلة نصية باسم formatTemplate، ثمَّ تستدعي الدالة ()format عبرها مع تمرير سلسلتين نصيتين كوسيطين، ثمَّ تطبع الناتج:

fun main(args: Array<String>) {
  var formatTemplate = "%-2s\t%s"

  println(formatTemplate.format("%b", "hsoub")) // %b	hsoub
}

انظر أيضًا

• foldIndexed()‎: تُراكِم الدالةfoldIndexed()‎ القيم بدءًا من القيمة المُمرّرة initial وتطبّق العملية operation من اليسار إلى اليمين على القيمة الراهنة وعلى الحرف الموالي في  سلسلة الحروف التي استُدعيت عبرها وكذلك فهرسه. ثم تُعيد القيمة النهائية. 

• fold()‎: تُراكِم الدالةfold()‎ القيم بدءًا من القيمة المُمرّرة initial وتطبّق العملية operation من اليسار إلى اليمين على القيمة الراهنة وعلى الحرف الموالي في  سلسلة الحروف التي استُدعيت عبرها. ثم تُعيد القيمة النهائية. 

• elementAt()‎: تعيد الحرف الموجود في الفهرس المُحدّد في سلسلة الحروف التي استُدعيت عبرها، في حال كان الفهرس خارج الحدود فستطلق الاستثناء IndexOutOfBoundsException. 

مصادر

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