صفحة الصنف Dir
في روبي
كائنات الصنف Dir
هي مجاري مجلدات (directory streams) تمثِّل الجلدات في نظام الملفات الأساسي لنظام التشغيل. فهي توفر طرائق متعددة لعرض المجلدات ومحتوياتها. انظر أيضًا صفحة الصنف File
لمزيد من المعلومات.
يحوي المجلد المستخدم في الأمثلة الموجودة في صفحات التوابع ملفين عاديين هما: config.h
و main.rb
، بالإضافة إلى المجلد الأب (..
) ، والمجلد نفسه (.
).
توابع الصنف العامة (Public Class Methods)
المعامل []
يكافئ استدعاء Dir.glob([string,...], 0)
.
chdir
يغيِّر مجلد العمل (working directory) الحالي للعملية الحالية إلى مجلَّدٍ محدَّدٍ.
children
يعيد مصفوفة تحوي جميع أسماء الملفات في المجلد المحدد باستثناء ".
" و "..
".
chroot
يغير المجلد الجذر (root) لنظام الملفات الخاص بالعملية الحالية.
each_child
يستدعي الكتلة المعطاة على كل ملف أو مجلد موجود في المجلد المحدد باستثناء "..
" و ".
" إذ يمُمرّر أسماء تلك الملفات كوسائط إلى الكتلة.
delete
يحذف مجلدًا محدَّدًا.
?empty
يتحقق فيما إذا كان المجلد المعطى فارغًا.
entries
يتحقق فيما إذا كان الملف المعطى مجلدًا.
?exist
يتحقق مما إذا كان الملف المعطى مجلدًا.
exists
أصبح مهملًا، لذا لا تستخدمه بعد الآن. استعمل التابع ?exist
عوضًا عنه.
foreach
يستدعي الكتلة المعطاة على كل ملف من الملفات الموجودة في المجلد المحدد، إذ يمُمرّر أسماء تلك الملفات كوسائط للكتلة.
getwd
يعيد مسار مجلد العمل (working directory) الحالي للعملية الحالية.
glob
يوسّع الوسيطَ pattern
الممرّر (انظر فقرة البنية العامة)، الذي هو سلسلة نصية نمطية (pattern string) أو مصفوفة من السلاسل النصية النمطية، ويعيد مصفوفة تحتوي أسماء الملفات المُطابقة لذلك النمط.
home
يعيد المجلد الرئيسي (home directory) للمستخدم الحالي أو للمستخدم المعطى في حال إعطائه.
التابع mkdir
ينشئ التابع mkdir
مجلدًا جديدًا.
التابع new
يعيد التابع new
كائنًا مجلديًا (directory object) جديدًا خاصًا بالمجلد المعطى.
التابع open
في حال عدم إعطاء كتلة، فإنّ التابع open
هو مرادف لـ Dir::new
. وفي حالة إعطاء كتلة، فسيُمرّر إليها aDir
كمعامل.
التابع pwd
يعيد التابع pwd
مسار مجلد العمل (working directory) الحالي للعملية (process) على شكل سلسلة نصية.
التابع rmdir
يمحو التابع rmdir
المجلد المحدد، سيُطلق خطأ من صنف فرعي (subclass) من SystemCallError
في حال لم يكن المجلد فارغًا .
التابع unlink
يمحو التابع unlink
المجلد المحدد، سيُطلق خطأ من صنف فرعي (subclass) من SystemCallError
في حال لم يكن المجلد فارغًا.
توابع الكائن العامة (Public Instance Methods)
التابع close
يغلق التابع close
مجرى المجلد (directory stream)، استدعاء هذا التابع على على كائن Dir
مغلق صار يُتجاهل منذ روبي 2.3.
التابع each
يستدعي التابع each
الكتلة المعطاة على كل ملف من الملفات المحتواة في المجلد المحدد. حيث يمُمرّر أسماء تلك الملفات كوسائط للكتلة.
التابع fileno
يعيد التابع fileno
عددًا صحيحًا يمثل واصف الملف العددي (numeric file descriptor) المُستخدم في الكائن من صنف Dir
الذي استُدعي معه.
التابع inspect
يعيد التابع inspect
سلسلة نصية تصف الكائن (من صنف Dir
) الذي استُدعي معه.
التابع path
يعيد التابع path
المسار المُمرّر إلى الباني new
على شكل سلسلة نصية.
التابع pos
يعيد التابع pos
الموضع الحالي في الكائن من صنف Dir
الذي استٌدعي معه. أنظر أيضًا التابع seek
.
التابع seek
يذهب التابع seek
إلى موضع محدد في الكائن من صنف Dir
الذي استٌدعي معه.
التعبير pos =
التعبير pos =
هو مرادف للتابع seek
. بيد أنّه يعيد معامل الموضع (position parameter).
التابع read
يقرأ التابع read
المدخل الموالي في الكائن المجلدي (dir object) الذي استُدعي معه ثم يعيده على شكل سلسلة نصية. وفي نهاية المجرى يعيد القيمةnil
.
التابع rewind
يعيد التابع rewind
الموضع الراهن عند المدخل الأول.
التابع tell
يعيد التابع tell
الموضع الحالي في الكائن من صنف Dir
الذي استٌدعي معه. أنظر أيضًا التابع seek
.
التابع to_path
يعيد التابع to_path
المسار المُمرّر (في الوسيط path
) إلى الباني new
على شكل سلسلة نصية.