الفرق بين المراجعتين لصفحة: «Ruby/IO»
لا ملخص تعديل |
لا ملخص تعديل |
||
| سطر 44: | سطر 44: | ||
puts "Your screen is #{columns} wide and #{rows} tall"</syntaxhighlight> | puts "Your screen is #{columns} wide and #{rows} tall"</syntaxhighlight> | ||
==توابع الصنف العامة (Public Class Methods)== | ==توابع الصنف العامة (Public Class Methods)== | ||
===[[Ruby/IO/binread | binread]]=== | |||
يفتح الملف، ثم يتموضع اختياريا في الموضع المعطى <code>offset</code> (انظر فقرة البنية العامة)، ثم يُعيد <code>length</code> بايت (تساوي قيمته الافتراضية طول بقية الملف). يضمن التابع <code>binread</code> أن يُغلق الملف قبل العودة. وضع الفتح سيكون "rb:ASCII-8BIT". | |||
===[[Ruby/IO/binwrite | binwrite]]=== | |||
مشابه للتابع <code>IO.write</code>X، ما عدا أنه يفتح الملف في الوضع الثنائي (binary mode) وبالترميز ASCII-8BIT ("wb: ASCII-8BIT"). | |||
===[[Ruby/IO/copy_stream | copy_stream]]=== | |||
ينسخ التابع <code>[[Ruby/IO/copy_stream|::copy_stream]]</code> المصدر المعطى <code>src</code> إلى <code>dst</code> (انظر فقرة البنية العامة). الوسيطان <code>src</code> و <code>dst</code> يمكن أن يكونا إما اسماء ملفات، أو كائن مشابهة للصنف IO. يجب أن يكون للكائنات المشابهة لـ IO بالنسبة للوسيط <code>src</code> التابع <code>[[Ruby/IO/readpartial|readpartial]]</code> أو <code>[[Ruby/IO/read-i|read]]</code>. كما يجب أن يكون للكائنات المشابهة لـ IO بالنسبة للوسيط <code>dst</code> التابع <code>[[Ruby/IO/write-i|write]]</code>. (يمكن استخدام الآليات خاصة، مثل استدعاء نظام sendfile، في بعض الحالات المناسبة.) | |||
===[[Ruby/IO/for_fd | for_fd]]=== | |||
مرادف للتابع <code>IO.new</code>. | |||
===[[Ruby/IO/foreach | foreach]]=== | |||
ينفذ الكتلة المعطاة على كل سطر في منفذ [[Ruby/IO|مجرى د/خ]] المسمى، حيث يتم فصل الأسطر بواسطة <code>sep</code>. | |||
===[[Ruby/IO/new | new]]=== | |||
يُعيد كائنًا جديدًا من النوع <code>[[Ruby/IO|IO]]</code> لواصف الملف (file descriptor) المعطى <code>fd</code> (انظر فقرة البنية العامة) والوضع <code>mode</code>. يمكن استخدام <code>opt</code> لتحديد أجزاء من <code>mode</code> بطريقة أكثر قابلية للقراءة. انظر أيضًا صفحتي <code>[[Ruby/IO/sysopen|::sysopen]]</code> و <code>[[Ruby/IO/for_fd|::for_fd]]</code>. | |||
===[[Ruby/IO/open | open]]=== | |||
عند عدم تمرير كتلة، فسيكون التابع <code>IO.open</code> مرادفاً للتابع <code>[[Ruby/IO/new|::new]]</code>. أما في حال تمرير الكتلة البرمجية، فسيُمرّر إليها <code>io</code> (انظر فقرة البنية العامة) كوسيط، وسيتم إغلاق [[Ruby/IO|مجرى د/خ]] (<code>[[Ruby/IO|IO]]</code>) تلقائيًا عند إنهاء الكتلة. في هذه الحالة، سيعيد التابع <code>[[Ruby/IO/open|::open]]</code> قيمة الكتلة. | |||
===[[Ruby/IO/pipe | pipe]]=== | |||
ينشئ زوجًا من مداخل الأنابيب (pipe endpoints) (متصلة ببعضها البعض) ثم يعيدها على هيئة [[Ruby/Array|مصفوفة]] ثنائية من [[Ruby/IO|مجاري د/خ]] <code>IO</code>: <code>[</code> <code>read_io</code> و <code>write_io</code> <code>]</code>. | |||
===[[Ruby/IO/popen | popen]]=== | |||
ينفذ التعليمة المعطاة (انظر فقرة البنية العامة) على شكل عملية فرعي (subprocess)؛ سيتم توصيل المدخلات والمخرجات القياسية للعملية الفرعية إلى [[Ruby/IO|مجرى د/خ]] (<code>IO</code>) المُعاد. | |||
===[[Ruby/IO/read | read]]=== | |||
يفتح الملف، ثم يتموضع اختياريا في الموضع المعطى <code>offset</code> (انظر فقرة البنية العامة)، ثم يُعيد <code>length</code> بايت (تساوي قيمته الافتراضية طول بقية الملف). يضمن التابع <code>read</code> أن يُغلق الملف قبل العودة. | |||
===[[Ruby/IO/readlines | readlines]]=== | |||
يقرأ كامل الملف المحدد بواسطة <code>name</code> (انظر فقرة البنية العامة) سطرًا سطرًا، ويعيد تلك السطور في [[Ruby/Array|مصفوفة]]. تُفصل السطو بواسطة <code>sep</code>. | |||
===[[Ruby/IO/select | select]]=== | |||
يستدعي select(2). ويقوم بمراقبة [[Ruby/Array|المصفوفة]] المعطاة المكونة من [[Ruby/IO|مجرى د/خ]] (كائنات <code>IO</code>)، وينتظر حتى يكون أحد كائنات <code>IO</code> جاهزًا للقراءة، وجاهزا للكتابة، ويكون لها استثناءات معلقة (pending exceptions) على التوالي، ثم يعيد [[Ruby/Array|مصفوفة]] تحتوي على [[Ruby/Array|مصفوفات]] مكونة من [[Ruby/IO|مجرى د/خ]] تلك كائنات <code>[[Ruby/IO|IO]]</code> السابقة. ستعاد القيمة <code>nil</code> إذا تم إعطاء قيمة للوسيط الاختياري <code>timeout</code> (انظر فقرة البنية العامة)، ولم يكن أي من [[Ruby/IO|مجاري د/خ]] كائن <code>IO</code> جاهزاً خلال <code>timeout</code> ثانية. | |||
===[[Ruby/IO/sysopen | sysopen]]=== | |||
يفتح المسار المحدد، ثم يعيد واصف الملف الأساسي ك[[Ruby/Integer|عدد صحيح]] <code>[[Ruby/Integer|Integer]]</code>. | |||
===[[Ruby/IO/try_convert | try_convert]]=== | |||
يحاول تحويل الوسيط <code>obj</code> (انظر فقرة البنية العامة) إلى [[Ruby/IO|مجرى د/خ]] (<code>[[Ruby/IO|IO]]</code>)، باستخدام التابع <code>[[Ruby/IO/to_io|#to_io]]</code>. تم يعيد [[Ruby/IO|مجرى د/خ]] <code>[[Ruby/IO|IO]]</code> المُحوّل، أو يعيد <code>nil</code> إذا تعذر تحويل <code>obj</code> لأي سبب من الأسباب. | |||
===[[Ruby/IO/write | write]]=== | |||
يفتح الملف، ويتموضع (seeks) اختياريا عند الإزاحة <code>offset</code> المعطاة (انظر فقرة البنية العامة)، ثم يكتب <code>string</code>، ثم يعيد طول [[Ruby/String|السلسلة النصية]] المكتوبة. يضمن التابع <code>write</code> أن يُغلق الملف قبل العودة. إذا لم يتم إعطاء <code>offset</code> في وضع الكتابة (write mode)، سيتم اقتطاع الملف. خلاف ذلك، لا يُقتطع. | |||
===[[Ruby/IO/left_shift | <<]]=== | |||
مجرى الإخراج النصي <code>[[Ruby/String|String]]</code> - يكتب <code>obj</code> (انظر فقرة البنية العامة) في المجرى <code>ios</code>. سيتم تحويل <code>obj</code> إلى [[Ruby/String|سلسلة نصية]] باستخدام <code>to_s</code>. | |||
===[[Ruby/IO/advise | advise]]=== | |||
يعلن عن نية الوصول إلى البيانات من الملف الحالي وفق نمط محدد. على أنظمة التشغيل التي لا تدعم استدعاء النظام <code>posix_fadvise(2)</code>، هذه التابع عبارة عن عملية فارغة (no-op). | |||
===[[Ruby/IO/autoclose-3D | autoclose=]]=== | |||
يُعيّن قيمة راية الإغلاق التلقائي. | |||
===[[Ruby/IO/autoclose-3F | autoclose?]]=== | |||
يُعيد القيمة <code>true</code> إن كان واصف الملف الأساسي ل[[Ruby/IO|مجرى د/خ]] <code>ios</code> سيتم إغلاقه تلقائياً عند الانتهاء منه، وإلا سيُعيد <code>false</code>. | |||
===[[Ruby/IO/binmode | binmode]]=== | |||
يضع [[Ruby/IO|مجرى د/خ]] <code>ios</code> في الوضع الثنائي (binary mode). بمجرد أن يصير المجرى في الوضع الثنائي، فلا يمكن إعادته إلى الوضع غير الثنائي. | |||
===[[Ruby/IO/binmode-3F | binmode?]]=== | |||
يُعيد القيمة <code>true</code> إن كان [[Ruby/IO|مجرى د/خ]] <code>ios</code> (انظر فقرة البنية العامة) في الوضع الثنائي (binary mode). | |||
===[[Ruby/IO/bytes | bytes]]=== | |||
مرادف مُتجاوز للتابع <code>[[Ruby/IO/each_byte|each_byte]]</code>. | |||
===[[Ruby/IO/chars | chars]]=== | |||
مرادف مُتجاوز للتابع <code>[[Ruby/IO/each_char|each_char]]</code>. | |||
===[[Ruby/IO/close | close]]=== | |||
يغلق [[Ruby/IO|مجرى د/خ]] <code>ios</code> (انظر فقرة البنية العامة)، ويرسل (flushes) أي كتابات مُعلّقة إلى نظام التشغيل. المجرى لن يكون متاحًا لأي عمليات إضافية على البيانات؛ وفي حال محاولة إجراء مثل تلك العمليات، فسيُطللق الخطأ <code>IOError</code>. يتم إغلاق [[Ruby/IO|مجاري د/خ]] تلقائيًا من طرف جامع المهملات (garbage collector). | |||
===[[Ruby/IO/close_on_exec-3D | close_on_exec=]]=== | |||
يعين الراية close-on-exec. | |||
===[[Ruby/IO/close_on_exec-3F | close_on_exec?]]=== | |||
يُعيد القيمة <code>true</code> إن كانت الراية close_on_exec الخاصة ب[[Ruby/IO|مجرى د/خ]] <code>ios</code> تساوي false. | |||
===[[Ruby/IO/close_read | close_read]]=== | |||
يغلق طرف القراءة الخاص بمجرى [[Ruby/IO|مجرى د/خ]] مزدوج (duplex) (على سبيل المثال، إن كان يحتوي على مجرى قراءة وكتابة، مثل الأنابيب [pipes]). سيُطلق الاستثناء <code>IOError</code> إن لم يكن المجرى مزدوجًا. | |||
===[[Ruby/IO/close_write | close_write]]=== | |||
يغلق طرف الكتابة الخاص ب[[Ruby/IO|مجرى د/خ]] المزدوج [duplex] (على سبيل المثال، إن كان يحتوي على مجرى قراءة وكتابة، مثل الأنابيب [pipes]). سيُطلق الاستثناء <code>IOError</code> إذا لم يكن المجرى مزدوجًا. | |||
===[[Ruby/IO/closed-3F | closed?]]=== | |||
يعيد القيمة <code>true</code> ان كان [[Ruby/IO|مجرى د/خ]] مغلقًا <code>ios</code> تماما (بالنسبة الى المجاري المزدوجة - duplex streams -، ينبغي أن يكون القارئ والكاتب مغلقين)، أو سيعيد <code>false</code> خلاف ذلك. | |||
===[[Ruby/IO/codepoints | codepoints]]=== | |||
هو مرادف مُتجاوز للتابع <code>[[Ruby/IO/each_codepoint|each_codepoint]]</code>. | |||
===[[Ruby/IO/each | each]]=== | |||
ينفذ الكتلة المعطاة لكل سطر في [[Ruby/IO|مجرى د/خ]] <code>ios</code>، حيث تُفصل الأسطر بواسطة <code>sep</code>. يجب أن يكون [[Ruby/IO|مجرى د/خ]] <code>ios</code> مفتوحا في وضعية القراءة، أو سيُطلق الاستثناء <code>IOError</code>. | |||
===[[Ruby/IO/each_byte | each_byte]]=== | |||
يستدعي الكتلة المعطاة مرة لكل بايت (0..255) في [[Ruby/IO|مجرى د/خ]] <code>ios</code>، مع تمرير البايت كوسيط. يجب أن يكون المجرى مفتوحًا في وضعية القراءة أو سيُرفع استثناء <code>IOError</code>. | |||
===[[Ruby/IO/each_char | each_char]]=== | |||
يستدعي الكتلة المعطاةة مرة لكل حرف في [[Ruby/IO|مجرى د/خ]] <code>ios</code>، مع تمرير الحرف كوسيط. يجب أن يكون المجرى مفتوحًا في وضعية القراءة أو سيُرفع استثناء <code>IOError</code>. | |||
===[[Ruby/IO/each_codepoint | each_codepoint]]=== | |||
يمرر رقم <code>[[Ruby/Integer|Integer]]</code> كل حرف (Integer ordinal) في [[Ruby/IO|مجرى د/خ]] <code>ios</code>، مع تمرير رمز اليونيكود (codepoint) كوسيط. يجب أن يكون المجرى مفتوحًا في وضعية القراءة أو سيُرفع استثناء <code>IOError</code>. | |||
===[[Ruby/IO/each_line | each_line]]=== | |||
ينفذ الكتلة المعطاة لكل سطر في [[Ruby/IO|مجرى د/خ]] <code>ios</code>، حيث تُفصل الأسطر بواسطة <code>sep</code>. يجب أن يكون [[Ruby/IO|مجرى د/خ]] <code>ios</code> مفتوحًا في وضعية القراءة أو سيُرفع استثناء <code>IOError</code>. | |||
===[[Ruby/IO/eof | eof]]=== | |||
يُعيد القيمة true إن كان [[Ruby/IO|مجرى د/خ]] <code>ios</code> في نهاية الملف، ما يعني أنه لا توجد بيانات أخرى للقراءة. يجب أن يكون المجرى مفتوحًا في وضعية القراءة أو سيُرفع استثناء <code>IOError</code>. | |||
===[[Ruby/IO/eof-3F | eof?]]=== | |||
يُعيد القيمة true إن كان [[Ruby/IO|مجرى د/خ]] <code>ios</code> في نهاية الملف، ما يعني أنه لا لم تعد هناك بيانات أخرى للقراءة. يجب أن يكون المجرى مفتوحًا في وضعية القراءة أو سيُرفع استثناء <code>IOError</code>. | |||
===[[Ruby/IO/external_encoding | external_encoding]]=== | |||
يُعيد [[Ruby/Encoding|الترميز]] <code>[[Ruby/Encoding|Encoding]]</code> الذي يمثل ترميز الملف. إن كان [[Ruby/IO|مجرى د/خ]] <code>io</code> في وضع الكتابة ولم يُحدّد أي ترميز، فستعاد <code>nil</code>. | |||
===[[Ruby/IO/fcntl | fcntl]]=== | |||
يوفر آلية لإصدار أوامر منخفضة المستوى للتحكم في [[Ruby/IO|مجاري د/خ]] I/O الموجهة بالملفات، أو الاستعلام عنها. الوسائط والنتائج تعتمد على النظام المُستخدم. إن كان الوسيط <code>arg</code> (انظر فقرة البنية العامة) عددًا، فستُمرر قيمته مباشرةً. وإن كان [[Ruby/String|سلسلة نصية]]، فستُفسر على أنها تسلسل ثنائي من البايتات (قد يكون التابع <code>Array#pack</code> طريقة مفيدة لإنشاء مثل هذه السلسلة). على منصات اليونيكس، راجع صفحة <code>fcntl(2)</code> لمزيد من التفاصيل. هذا التابع ليس مُتاح على جميع المنصات. | |||
===[[Ruby/IO/fdatasync | fdatasync]]=== | |||
يكتب على الفور جميع البيانات المخزنة في [[Ruby/IO|مجرى د/خ]] <code>ios</code> في القرص. | |||
===[[Ruby/IO/fileno | fileno]]=== | |||
يُعيد عددا صحيحا يمثل واصف الملف الرقمي ل[[Ruby/IO|مجرى د/خ]] <code>ios</code>. | |||
===[[Ruby/IO/flush | flush]]=== | |||
يرسل (Flushes) أي بيانات مخزنة في [[Ruby/IO|مجرى د/خ]] <code>ios</code> إلى نظام التشغيل (لاحظ أن هذا لا يشمل إلا التخزين المؤقت الداخلي لروبي؛ وقد يقوم نظام التشغيل بتخزين البيانات أيضًا). | |||
===[[Ruby/IO/fsync | fsync]]=== | |||
يكتب على الفور جميع البيانات المخزنة في [[Ruby/IO|مجرى د/خ]] <code>ios</code> في القرص. لاحظ أن <code>fsync</code> يختلف عن استخدام <code>IO#sync=</code>. حيث يضمن الأخير أن تُرسل البيانات من المخازن المؤقتة (buffers) لروبي، ولكنه لا يضمن أنّ نظام التشغيل سيكتبها بالفعل في القرص. | |||
===[[Ruby/IO/getbyte | getbyte]]=== | |||
يحصل على البايت (8-bit byte) الموالي (0..255) من [[Ruby/IO|مجرى د/خ]] <code>ios</code>. ويُعيد <code>nil</code> إن استُدعي عند نهاية الملف. | |||
===[[Ruby/IO/getc | getc]]=== | |||
يقرأ [[Ruby/String|سلسلة نصية]] مُؤلفة من حرف واحد من [[Ruby/IO|مجرى د/خ]] <code>ios</code>. ويُعيد <code>nil</code> إن استُدعي عند نهاية الملف. | |||
===[[Ruby/IO/gets | gets]]=== | |||
يقرأ "السطر" الموالي من [[Ruby/IO|مجرى د/خ]]. السطور مفصولة بواسطة <code>sep</code>. إن كان الفاصل يساوي <code>nil</code>، فسيقرأ المحتويات بالكامل، أما إن كان الفاصل معدوم الطول، فستُقرؤ فقرة في كل مرة من مجرى الإدخال (تُفصل الفقرات بسطرين منفصلين). يجب أن يكون المجرى مفتوحًا في وضعية القراءة أو سيُرفع استثناء <code>IOError</code>. سيُعاد السطر المقروء، وستُعين قيمته إلى <code>$_</code>. ستعاد القيمة <code>nil</code> إن تم استُدعي عند نهاية الملف. إن كان الوسيط الأول عددًا صحيحًا أو إن أعطي الوسيط الاختياري الثاني، فلن تكون [[Ruby/String|السلسلة النصية]] المعادة أطول من القيمة المحددة من حيث عدد البايتات (bytes). | |||
===[[Ruby/IO/inspect | inspect]]=== | |||
يُعيد [[Ruby/String|سلسلة نصية]] تصف [[Ruby/IO|مجرى د/خ]] الذي استُدعي معه <code>[[Ruby/IO|IO]]</code>. | |||
===[[Ruby/IO/internal_encoding | internal_encoding]]=== | |||
يعيد [[Ruby/Encoding|الترميز]] <code>[[Ruby/Encoding|Encoding]]</code> الخاص ب[[Ruby/String|السلسلة النصية]] الداخلية في حالة تحديد التحويل. على خلاف ذلك سيُعيد <code>nil</code>. | |||
===[[Ruby/IO/ioctl | ioctl]]=== | |||
يوفر آلية لإصدار أوامر منخفضة المستوى للتحكم في أجهزة [[Ruby/IO|مجاري د/خ]] I/O، أو الاستعلام عنها. الوسائط والنتائج تعتمد على النظام المُستخدم. إن كان الوسيط <code>arg</code> (انظر فقرة البنية العامة) عددًا، فستُمرر قيمته مباشرةً. وإن كان [[Ruby/String|سلسلة نصية]]، فستُفسر على أنها تسلسل ثنائي من البايتات لاستخدامه في منصات اليونيكس، راجع صفحة <code>ioctl(2)</code> لمزيد من التفاصيل. غير متاح على جميع المنصات. | |||
===[[Ruby/IO/isatty | isatty]]=== | |||
يُعيد القيمة <code>true</code> إن كان [[Ruby/IO|مجرى د/خ]] <code>ios</code> مربوطا بجهاز طرفي (tty)، أو يعيد <code>false</code> خلاف ذلك. | |||
===[[Ruby/IO/lineno | lineno]]=== | |||
يعيد رقم السطر الحالي في [[Ruby/IO|مجرى د/خ]] <code>ios</code>. يجب أن يكون المجرى مفتوحا في وضعية القراءة. يحسب التابع <code>lineno</code> عدد المرات التي يتم فيها استدعاء <code>[[Ruby/IO/gets|gets]]</code> بدلاً من عدد السطور الجديدة التي تمت مصادفتها. ستختلف القيمتان إن استُدعي <code>[[Ruby/IO/gets|gets]]</code> مع فاصل آخر غير فاصل السطر الجديد. | |||
===[[Ruby/IO/lineno-3D | lineno=]]=== | |||
يعيّن يدويًا رقم السطر الحالي ويعطيه القيمة المحددة. لن تُحدّث <code>$.</code> إلا عند القراءة التالية. | |||
===[[Ruby/IO/lines | lines]]=== | |||
مرادف مُتجاوز للتابع <code>[[Ruby/IO/each_line|each_line]]</code>. | |||
===[[Ruby/IO/pid | pid]]=== | |||
يُعيد معرف العملية (PID) الخاص بالعملية الفرعية (child process) تامرتبطة ب[[Ruby/IO|مجرى د/خ]] <code>ios</code>. سيتم تعيينه بواسطة التابع <code>IO.popen</code>. | |||
===[[Ruby/IO/pos | pos]]=== | |||
يُعيد الإزاحة (offset) الحالية (بالبايت) في [[Ruby/IO|مجرى د/خ]] <code>ios</code>. | |||
===[[Ruby/IO/pos-3D | pos=]]=== | |||
يسعى إلى التموضع عند الإزاحة المحددة (بالبايت) في [[Ruby/IO|مجرى د/خ]] <code>ios</code>. ليس مضمونا أن يكون التموضع صحيحًا عندما يكون [[Ruby/IO|مجرى د/خ]] <code>ios</code> في الوضع النصي (textmode). | |||
===[[Ruby/IO/pread | pread]]=== | |||
يقرأ <code>maxlen</code> (انظر فقرة البنية العامة) بايت من [[Ruby/IO|مجرى د/خ]] <code>ios</code> باستخدام استدعاء النظام pread، ثم يُعيدها ك[[Ruby/String|سلسلة نصية]] من غير تعديل إزاحة (offset) الواصف الأساسي. هذا مفيد مقارنة بالجمع بين <code>[[Ruby/IO/seek|#seek]]</code> و <code>[[Ruby/IO/read|#read]]</code> في كونه ذريًا (atomic)، مما يسمح لعدة [[Ruby/Thread|مهام فرعية]]/عمليات بالتشارك في نفس [[Ruby/IO|مجرى د/خ]] <code>[[Ruby/IO|IO]]</code> لقراءة الملف في مواضع مختلفة. هذا سيتجاوز أي مساحة تخزين مؤقت للمستخدمين من طبقة [[Ruby/IO|مجرى د/خ]] <code>[[Ruby/IO|IO]]</code>. في حال إعطاء الوسيط الاختياري <code>outbuf</code> (انظر فقرة البنية العامة)، فينبغي أن يشير إلى [[Ruby/String|سلسلة نصية]] <code>[[Ruby/String|String]]</code>، والتي ستتلقى البيانات. سيُطلق استثناء <code>SystemCallError</code> عند الخطأ، أو <code>EOFError</code> عند نهاية الملف، أو <code>NotImplementedError</code> إن لم يكن نظام التشغيل يدعم استدعاء النظام. | |||
===[[Ruby/IO/print | print]]=== | |||
يكتب الكائن(ات) المعطاة في [[Ruby/IO|مجرى د/خ]] <code>ios</code>. ثم يُعيد <code>nil</code>. | |||
===[[Ruby/IO/printf | printf]]=== | |||
ينسق ويكتب في [[Ruby/IO|مجرى د/خ]] <code>ios</code>، حيث يحول الوسائط المعطاة وفق سلسلة التنسيق الممررة format_string (انظر فقرة البنية العامة). انظر صفحة <code>Kernel#sprintf</code> لمزيد من التفاصيل. | |||
===[[Ruby/IO/putc | putc]]=== | |||
إن كان الوسيط المعطى <code>obj</code> (انظر فقرة البنية العامة) عددًا <code>[[Ruby/Numeric|Numeric]]</code>، فسيكتب الحرف الذي يكون رمزه هو البايت الأقل دلال (least-significant byte) من <code>obj</code>. وإن كان <code>obj</code> [[Ruby/String|سلسلة نصية]] <code>String</code>، فسيكتب أول حرف من <code>obj</code> في [[Ruby/IO|مجرى د/خ]] <code>ios</code>. خلاف ذلك، سيُطلق الاستثناء <code>TypeError</code>. | |||
===[[Ruby/IO/puts | puts]]=== | |||
يكتب الكائن(اات) المعطى في [[Ruby/IO|مجرى د/خ]] <code>ios</code>. ويكتب سطرًا جديدا بعد أي سطر لا ينتهي بالفعل بمحرف السطر الجديد. ثم يعيد <code>nil</code>. | |||
===[[Ruby/IO/pwrite | pwrite]]=== | |||
يكتب [[Ruby/String|السلسلة النصية]] المعطاة (انظر فقرة البنية العامة) في [[Ruby/IO|مجرى د/خ]] <code>ios</code> عند موضع الإزاحة <code>offset</code> باستخدام استدعاء النظام pwrite (). هذا مفيد مقارنة بالجمع بين <code>[[Ruby/IO/seek|#seek]]</code> و <code>[[Ruby/IO/write|#write]]</code> في كونه ذريًا (atomic)، مما يسمح لعدة [[Ruby/Thread|مهام فرعية]]/عمليات بالتشارك في نفس [[Ruby/IO|مجرى د/خ]] <code>[[Ruby/IO|IO]]</code> لقراءة الملف من مواضع مختلفة. هذا سيتجاوز أي مساحة تخزين مؤقت للمستخدمين من طبقة [[Ruby/IO|مجرى د/خ]] <code>[[Ruby/IO|IO]]</code>. سيعيد عدد البايتات المكتوبة. وسيُطلق الاستثناء <code>SystemCallError</code> في حال حدوث خطأ، أو <code>NotImplementedError</code> إذا لم يكن نظام الشغيل يدعم استدعاء النظام. | |||
===[[Ruby/IO/read-i | read]]=== | |||
يقرأ <code>length</code> بايتًا (انظر فقرة البنية العامة) من [[Ruby/IO|مجرى د/خ]]. | |||
===[[Ruby/IO/read_nonblock | read_nonblock]]=== | |||
يقرأ على الأكثر <code>maxlen</code> (انظر فقرة البنية العامة) بايتًا من [[Ruby/IO|مجرى د/خ]] <code>ios</code> باستخدام استدعاء النظام read(2) بعد تعيين O_NONBLOCK في واصف الملف (file descriptor) الأساسي. | |||
===[[Ruby/IO/readbyte | readbyte]]=== | |||
يقرأ البايت كما يفعل التابع <code>IO#getbyte</code>، إلا أنه يُطلق الاستثناء <code>EOFError</code> على نهاية الملف. | |||
===[[Ruby/IO/readchar | readchar]]=== | |||
يقرأ [[Ruby/String|سلسلة نصية]] مؤلفة من حرف واحد من [[Ruby/IO|مجرى د/خ]] <code>ios</code>. ويطلق الاستثناء <code>EOFError</code> عند نهاية الملف. | |||
===[[Ruby/IO/readline | readline]]=== | |||
يقرأ سطرًا كما يفعل التابع <code>IO#gets</code>، إلا أنه يُطلق الاستثناء <code>EOFError</code> عند نهاية الملف. | |||
===[[Ruby/IO/readlines-i | readlines]]=== | |||
يقرأ كل الأسطر الموجودة في [[Ruby/IO|مجرى د/خ]] <code>ios</code>، ثم يعيدها في [[Ruby/Array|مصفوفة]]. يتم فصل الأسطر بالوسيط الاختياري <code>sep</code> (انظر فقرة البنية العامة). إن كان الوسيط <code>sep</code> يساوي <code>nil</code>، فسسيُعاد بقية المجرى كتسجيلة (record) واحدة. إن كان الوسيط الأول عددًا صحيحًا، أو إن أعطي الوسيط الاختياري الثاني، فلن تكون [[Ruby/String|السلسلة النصية]] المعادة أطول من حيث عدد البايتات من القيمة المحددة. يجب أن يكون المجرى مفتوحًا في وضعية القراءة أو سيُطلق استثناء <code>IOError</code>. | |||
===[[Ruby/IO/readpartial | readpartial]]=== | |||
يقرأ <code>maxlen</code> (انظر فقرة البنية العامة) بايتًا على الأكثر من [[Ruby/IO|مجرى د/خ]]. لا يقوم بالتعطيل إلا في حال لم يكن في [[Ruby/IO|مجرى د/خ]] <code>ios</code> أي بيانات متوفرة آنيًا. لن يقوم بالتعطيل في حالة توفر بعض البيانات. | |||
===[[Ruby/IO/reopen | reopen]]=== | |||
يربط بين [[Ruby/IO|مجرى د/خ]] الذي استُدعي معه <code>ios</code> وبين [[Ruby/IO|مجرى د/خ]] المعطى في <code>other_IO</code> (انظر فقرة البنية العامة)، أو مجرى جديد يُفتح من المسار <code>path</code>. قد يؤدي هذا إلى تغيير الصنف الفعلي لهذا المجرى ديناميكيًا. | |||
===[[Ruby/IO/rewind | rewind]]=== | |||
يُموضِع [[Ruby/IO|مجرى د/خ]] الذي استُدعي معه <code>ios</code> عند بداية الإدخال، مع تعيين <code>[[Ruby/IO/lineno|lineno]]</code> عند القيمة صفر. | |||
===[[Ruby/IO/seek | seek]]=== | |||
يسعى إلى التموضع عند الإزاحة المعطاة <code>anInteger</code> في [[Ruby/IO|مجرى د/خ]] وفقا لقيمة <code>whence</code> (انظر فقرة البنية العامة): | |||
===[[Ruby/IO/set_encoding | set_encoding]]=== | |||
في حال تمرير وسيط واحد، فستوسم [[Ruby/String|السلسلة النصية]] المقروءة من [[Ruby/IO|مجرى د/خ]] وفق [[Ruby/Encoding|الترميز]] المحدد. إن كان الترميز على هيئة حرفي ترميز مفصولين بنقطتين رأسيتين "A: B"، فستُحوّل [[Ruby/String|السلسلة النصية]] المقروءة من الترميز A (الترميز الخارجي) إلى الترميز B (الترميز الداخلي)، ثم توسم بـ B. في حال إعطاء وسيطين، فيجب أن يكونا كائني [[Ruby/Encoding|ترميز]]، أو اسمي ترميز، حيث يمثل أولها الترميز الخارجي، فيما يمثل ثانيهما الترميز الداخلي. في حال تحديد الترميز الخارجي والترميز الداخلي، فسيحدد الوسيط الاختياري opt خيارات التحويل. | |||
===[[Ruby/IO/stat | stat]]=== | |||
يُعيد معلومات الحالة ل[[Ruby/IO|مجرى د/خ]] الذي استُدعي معه <code>ios</code> على هيئة كائن من النوع <code>File::Stat</code>. | |||
===[[Ruby/IO/sync | sync]]=== | |||
يُعيد قيمة راية وضع المزامنة "sync mode" الحالية ل[[Ruby/IO|مجرى د/خ]] <code>ios</code>. عندما تكون قيمة وضع المزامنة true، فسيتم إرسال كل المخرجات فورًا إلى نظام التشغيل، ولن يُخزّن مؤقتًا من قبل روبي داخليًا. انظر أيضا صفحة <code>IO#fsync</code>. | |||
===[[Ruby/IO/sync-3D | sync=]]=== | |||
يضبط قيمة راية وضع المزامنة “sync mode' عند إحدى القيمتين <code>true</code> أو <code>false</code>. عندما تكون قيمة وضع المزامنة true، فسيتم إرسال كل المخرجات فورًا إلى نظام التشغيل، ولن تُخزن (buffered) داخليًا. يُعيد الحالة الجديدة. انظر أيضا صفحة <code>IO#fsync</code>. | |||
===[[Ruby/IO/sysread | sysread]]=== | |||
يقرأ <code>maxlen</code> (انظر فقرة البنية العامة) بايتًا من [[Ruby/IO|مجرى د/خ]] الذي استُدعي معه <code>ios</code> باستخدام قراءة منخفضة المستوى (low-level read) ويُعيدها ك[[Ruby/String|سلسلة نصية]]. لا تخلط هذا التابع مع التوابع الأخرى التي تقرأ من [[Ruby/IO|مجرى د/خ]] <code>ios</code>، أو قد تحصل على نتائج غير متوقعة. | |||
===[[Ruby/IO/sysseek | sysseek]]=== | |||
يسعى إلى التموضع عند الإزاحة المعطاة <code>offset</code> (انظر فقرة البنية العامة) وفقا لقيمة <code>whence</code> (انظر <code>IO#seek</code> للتعرف على القيم الممكنة للوسيط <code>whence</code>). يُعيد الإزاحة الجديدة للملف. | |||
===[[Ruby/IO/syswrite | syswrite]]=== | |||
يكتب [[Ruby/String|السلسلة النصية]] المعطاة في [[Ruby/IO|مجرى د/خ]] الذي استُدعي معه <code>ios</code> باستخدام كتابة منخفض المستوى (low-level write). ثم يعيد عدد البايتات المكتوبة. لا تخلط هذا التابع مع التوابع الأخرى التي تكتب في [[Ruby/IO|مجرى د/خ]] <code>ios</code>، أو قد تحصل على نتائج غير متوقعة. يُطلق استثناء <code>SystemCallError</code> عند حدوث خطأ. | |||
===[[Ruby/IO/tell | tell]]=== | |||
يُعيد الإزاحة الحالية (بالبايت) في [[Ruby/IO|مجرى د/خ]] <code>ios</code>. | |||
===[[Ruby/IO/to_i | to_i]]=== | |||
===[[Ruby/IO/to_io | to_io]]=== | |||
يعيد [[Ruby/IO|مجرى د/خ]] الذي استُدعي معه <code>ios</code>. | |||
===[[Ruby/IO/tty-3F | tty?]]=== | |||
يُعيد القيمة <code>true</code> إن كان [[Ruby/IO|مجرى د/خ]] <code>ios</code> مربوطا بطرفية (tty)، أو يعيد <code>false</code> خلاف ذلك. | |||
===[[Ruby/IO/ungetbyte | ungetbyte]]=== | |||
يدفع (Pushes back) البايتات (التي تم تمريرها كوسيط) إلى [[Ruby/IO|مجرى د/خ]] الذي استُدعي معه <code>ios</code>، بحيث ستعيدها القراءة التالية من المخزن المؤقت (buffer). لا يمكنك أن تدفع إلا بايتًا واحدا فقط قبل عملية القراءة اللاحقة (أي، لن تتمكن من قراءة إلا آخر بايت من البايتات التي دفتعها). ليس له أي تأثير مع القراءات غير التخزينية (unbuffered reads) (مثل <code>IO#sysread</code>). | |||
===[[Ruby/IO/ungetc | ungetc]]=== | |||
يدفع حرفا واحدا (المُمرر كوسيط) في [[Ruby/IO|مجرى د/خ]] الذي استُدعي معه <code>ios</code>، بحيث ستعيدها القراءة التالية من المخزن المؤقت (buffer). لا يمكنك أن تدفع إلا حرف واحد فقط قبل عملية القراءة اللاحقة (أي، لن تتمكن من قراءة إلا آخر حرف من الحروف التي دفتعها). ليس له أي تأثير مع القراءات غير التخزينية (unbuffered reads) (مثل <code>IO#sysread</code>). | |||
===[[Ruby/IO/write-i | write]]=== | |||
يكتب [[Ruby/String|السلاسل النصية]] المعطاة في [[Ruby/IO|مجرى د/خ]] <code>ios</code>. يجب أن يكون المجرى مفتوحا في وضعية للكتابة. سيتم تحويل الوسائط غير النصية إلى [[Ruby/String|سلسلة نصية]] باستخدام <code>to_s</code>. يُعيد عدد البايتات المكتوبة في الإجمال. | |||
===[[Ruby/IO/write_nonblock | write_nonblock]]=== | |||
يكتب [[Ruby/String|السلسلة النصية]] المعطاة في <code>ios</code> باستخدام استدعاء النظام write(2) بعد تعيين O_NONBLOCK لواصف الملف (file descriptor) الأساسي. | |||
==مصادر== | |||
*[http://ruby-doc.org/core-2.5.1/IO.html قسم الصنف IO في توثيق روبي الرسمي.] | |||
مراجعة 23:02، 13 نوفمبر 2018
الصنف IO هو أساس كل عمليات الإدخال والإخراج في روبي. مجرى د/خ (I/O stream) قد يكون مزدوج الاتجاه (duplexed)، ولذلك قد يستخدم أكثر من مجرى واحد من مجاري نظام التشغيل.
الكثير من الأمثلة الواردة في في هذا القسم تستخدم الصنف File، وهو االصنف الفرعي (subclass) القياسي الوحيد للصنف IO. الصنفان يرتبطان ارتباطًا وثيقًا.
مثل صنف الملفات، فإنّ المكتبة Socket تشتق أصنافًا فرعيةً من الصنف IO (مثل TCPSocket أو UDPSocket).
يمكن أن ينشئ التابع Kernel#open كائنات من الصنف IO (أو File) من أنواع الوسائط التالية:
- سلسلة نصية لتمثيل اسم ملف مناسب لنظام التشغيل المستخدم.
- سلسلة نصية تبدأ بالمحرف
"|"كناية عن عملية فرعية (subprocess). يتم استدعاء الجزء الموالي للمحرف"|"من السلسلة النصية كعملية (process)، هذه العملية ستكون متصلة بقنوات الإدخال/الإخراج (د/خ) المناسبة. - إن كانت السلسلة النصية تساوي
"|-"، فسيتم إنشاء نسخة (instance) أخرى من روبي كعملية فرعية.
يمكن فتح مجرى د/خ (IO) مع مختلف أوضاع الملفات (مثلًا، وضع القراءة فقط [read-only] أو الكتابة فقط [write-only]) ووفق الترميزات المناسبة لأجل إجراء عمليات التحويل. انظر صفحة التابع new للتعرف على هذه الخيارات. وانظر صفحة Kernel#open لمزيد من التفاصيل حول مختلف تنسيقات الأوامر المذكورة أعلاه.
يمكن أيضًا استخدام التابع popen أو المكتبة Open3 أو Process#spawn للتواصل مع العمليات الفرعية عبر مجرى د/خ (IO).
ستُحول روبي أسماء المسارات بما يتوافق مع نظام التشغيل المستخدم إن أمكن. على سبيل المثال، في نظام ويندوز، سيُفتح اسم الملف "/gumby/ruby/test.rb" باعتباره "\gumby\ruby\test.rb".
عند تحديد اسم ملف بنمط ويندوز في سلسلة نصية، تذكر أن تُخلّص (escape) الشرطات المائلة العكسية، مثلا:
"C:\\gumby\\ruby\\test.rb"
سوف نستخدم في الأمثلة الموجودة في صفحات التوابع الشرطة المائلة للأمام على نمط اليونيكس؛ يمكن الحصول على الحرف الفاصل الخاص بنظام التشغيل عبر File::ALT_SEPARATOR.
توفر الثابتة العامة ARGF (يمكن الدخول إليها عبر $<) مجرًى مشابهًا لمجرى د/خ (I/O)، والذي يسمح بالوصول إلى كافة الملفات المذكورة في سطر الأوامر (أو في المجرى STDIN في حال لم يذكر أي ملف). يمكن استخدام التابع ARGF#path ومرادفه ARGF#filename للوصول إلى اسم الملف الذي تتم قراءته حاليًا.
الملحقة io/console
توفر الملحقة io/console توابع للتفاعل مع وحدة التحكم (console). يمكن الوصول إلى وحدة التحكم عبر التابع IO.console، أو من مجاري د/خ (I/O) القياسية input و output و error.
استيراد io/console يؤدي إلى إضافة التوابع التالية:
IO::consoleIO#rawIO#raw!IO#cookedIO#cooked!IO#getchIO#echo=IO#echo?IO#noechoIO#winsizeIO#winsize=IO#iflushIO#ioflushIO#oflush
مثال:
require 'io/console'
rows, columns = $stdout.winsize
puts "Your screen is #{columns} wide and #{rows} tall"
توابع الصنف العامة (Public Class Methods)
binread
يفتح الملف، ثم يتموضع اختياريا في الموضع المعطى offset (انظر فقرة البنية العامة)، ثم يُعيد length بايت (تساوي قيمته الافتراضية طول بقية الملف). يضمن التابع binread أن يُغلق الملف قبل العودة. وضع الفتح سيكون "rb:ASCII-8BIT".
binwrite
مشابه للتابع IO.writeX، ما عدا أنه يفتح الملف في الوضع الثنائي (binary mode) وبالترميز ASCII-8BIT ("wb: ASCII-8BIT").
copy_stream
ينسخ التابع ::copy_stream المصدر المعطى src إلى dst (انظر فقرة البنية العامة). الوسيطان src و dst يمكن أن يكونا إما اسماء ملفات، أو كائن مشابهة للصنف IO. يجب أن يكون للكائنات المشابهة لـ IO بالنسبة للوسيط src التابع readpartial أو read. كما يجب أن يكون للكائنات المشابهة لـ IO بالنسبة للوسيط dst التابع write. (يمكن استخدام الآليات خاصة، مثل استدعاء نظام sendfile، في بعض الحالات المناسبة.)
for_fd
مرادف للتابع IO.new.
foreach
ينفذ الكتلة المعطاة على كل سطر في منفذ مجرى د/خ المسمى، حيث يتم فصل الأسطر بواسطة sep.
new
يُعيد كائنًا جديدًا من النوع IO لواصف الملف (file descriptor) المعطى fd (انظر فقرة البنية العامة) والوضع mode. يمكن استخدام opt لتحديد أجزاء من mode بطريقة أكثر قابلية للقراءة. انظر أيضًا صفحتي ::sysopen و ::for_fd.
open
عند عدم تمرير كتلة، فسيكون التابع IO.open مرادفاً للتابع ::new. أما في حال تمرير الكتلة البرمجية، فسيُمرّر إليها io (انظر فقرة البنية العامة) كوسيط، وسيتم إغلاق مجرى د/خ (IO) تلقائيًا عند إنهاء الكتلة. في هذه الحالة، سيعيد التابع ::open قيمة الكتلة.
pipe
ينشئ زوجًا من مداخل الأنابيب (pipe endpoints) (متصلة ببعضها البعض) ثم يعيدها على هيئة مصفوفة ثنائية من مجاري د/خ IO: [ read_io و write_io ].
popen
ينفذ التعليمة المعطاة (انظر فقرة البنية العامة) على شكل عملية فرعي (subprocess)؛ سيتم توصيل المدخلات والمخرجات القياسية للعملية الفرعية إلى مجرى د/خ (IO) المُعاد.
read
يفتح الملف، ثم يتموضع اختياريا في الموضع المعطى offset (انظر فقرة البنية العامة)، ثم يُعيد length بايت (تساوي قيمته الافتراضية طول بقية الملف). يضمن التابع read أن يُغلق الملف قبل العودة.
readlines
يقرأ كامل الملف المحدد بواسطة name (انظر فقرة البنية العامة) سطرًا سطرًا، ويعيد تلك السطور في مصفوفة. تُفصل السطو بواسطة sep.
select
يستدعي select(2). ويقوم بمراقبة المصفوفة المعطاة المكونة من مجرى د/خ (كائنات IO)، وينتظر حتى يكون أحد كائنات IO جاهزًا للقراءة، وجاهزا للكتابة، ويكون لها استثناءات معلقة (pending exceptions) على التوالي، ثم يعيد مصفوفة تحتوي على مصفوفات مكونة من مجرى د/خ تلك كائنات IO السابقة. ستعاد القيمة nil إذا تم إعطاء قيمة للوسيط الاختياري timeout (انظر فقرة البنية العامة)، ولم يكن أي من مجاري د/خ كائن IO جاهزاً خلال timeout ثانية.
sysopen
يفتح المسار المحدد، ثم يعيد واصف الملف الأساسي كعدد صحيح Integer.
try_convert
يحاول تحويل الوسيط obj (انظر فقرة البنية العامة) إلى مجرى د/خ (IO)، باستخدام التابع #to_io. تم يعيد مجرى د/خ IO المُحوّل، أو يعيد nil إذا تعذر تحويل obj لأي سبب من الأسباب.
write
يفتح الملف، ويتموضع (seeks) اختياريا عند الإزاحة offset المعطاة (انظر فقرة البنية العامة)، ثم يكتب string، ثم يعيد طول السلسلة النصية المكتوبة. يضمن التابع write أن يُغلق الملف قبل العودة. إذا لم يتم إعطاء offset في وضع الكتابة (write mode)، سيتم اقتطاع الملف. خلاف ذلك، لا يُقتطع.
<<
مجرى الإخراج النصي String - يكتب obj (انظر فقرة البنية العامة) في المجرى ios. سيتم تحويل obj إلى سلسلة نصية باستخدام to_s.
advise
يعلن عن نية الوصول إلى البيانات من الملف الحالي وفق نمط محدد. على أنظمة التشغيل التي لا تدعم استدعاء النظام posix_fadvise(2)، هذه التابع عبارة عن عملية فارغة (no-op).
autoclose=
يُعيّن قيمة راية الإغلاق التلقائي.
autoclose?
يُعيد القيمة true إن كان واصف الملف الأساسي لمجرى د/خ ios سيتم إغلاقه تلقائياً عند الانتهاء منه، وإلا سيُعيد false.
binmode
يضع مجرى د/خ ios في الوضع الثنائي (binary mode). بمجرد أن يصير المجرى في الوضع الثنائي، فلا يمكن إعادته إلى الوضع غير الثنائي.
binmode?
يُعيد القيمة true إن كان مجرى د/خ ios (انظر فقرة البنية العامة) في الوضع الثنائي (binary mode).
bytes
مرادف مُتجاوز للتابع each_byte.
chars
مرادف مُتجاوز للتابع each_char.
close
يغلق مجرى د/خ ios (انظر فقرة البنية العامة)، ويرسل (flushes) أي كتابات مُعلّقة إلى نظام التشغيل. المجرى لن يكون متاحًا لأي عمليات إضافية على البيانات؛ وفي حال محاولة إجراء مثل تلك العمليات، فسيُطللق الخطأ IOError. يتم إغلاق مجاري د/خ تلقائيًا من طرف جامع المهملات (garbage collector).
close_on_exec=
يعين الراية close-on-exec.
close_on_exec?
يُعيد القيمة true إن كانت الراية close_on_exec الخاصة بمجرى د/خ ios تساوي false.
close_read
يغلق طرف القراءة الخاص بمجرى مجرى د/خ مزدوج (duplex) (على سبيل المثال، إن كان يحتوي على مجرى قراءة وكتابة، مثل الأنابيب [pipes]). سيُطلق الاستثناء IOError إن لم يكن المجرى مزدوجًا.
close_write
يغلق طرف الكتابة الخاص بمجرى د/خ المزدوج [duplex] (على سبيل المثال، إن كان يحتوي على مجرى قراءة وكتابة، مثل الأنابيب [pipes]). سيُطلق الاستثناء IOError إذا لم يكن المجرى مزدوجًا.
closed?
يعيد القيمة true ان كان مجرى د/خ مغلقًا ios تماما (بالنسبة الى المجاري المزدوجة - duplex streams -، ينبغي أن يكون القارئ والكاتب مغلقين)، أو سيعيد false خلاف ذلك.
codepoints
هو مرادف مُتجاوز للتابع each_codepoint.
each
ينفذ الكتلة المعطاة لكل سطر في مجرى د/خ ios، حيث تُفصل الأسطر بواسطة sep. يجب أن يكون مجرى د/خ ios مفتوحا في وضعية القراءة، أو سيُطلق الاستثناء IOError.
each_byte
يستدعي الكتلة المعطاة مرة لكل بايت (0..255) في مجرى د/خ ios، مع تمرير البايت كوسيط. يجب أن يكون المجرى مفتوحًا في وضعية القراءة أو سيُرفع استثناء IOError.
each_char
يستدعي الكتلة المعطاةة مرة لكل حرف في مجرى د/خ ios، مع تمرير الحرف كوسيط. يجب أن يكون المجرى مفتوحًا في وضعية القراءة أو سيُرفع استثناء IOError.
each_codepoint
يمرر رقم Integer كل حرف (Integer ordinal) في مجرى د/خ ios، مع تمرير رمز اليونيكود (codepoint) كوسيط. يجب أن يكون المجرى مفتوحًا في وضعية القراءة أو سيُرفع استثناء IOError.
each_line
ينفذ الكتلة المعطاة لكل سطر في مجرى د/خ ios، حيث تُفصل الأسطر بواسطة sep. يجب أن يكون مجرى د/خ ios مفتوحًا في وضعية القراءة أو سيُرفع استثناء IOError.
eof
يُعيد القيمة true إن كان مجرى د/خ ios في نهاية الملف، ما يعني أنه لا توجد بيانات أخرى للقراءة. يجب أن يكون المجرى مفتوحًا في وضعية القراءة أو سيُرفع استثناء IOError.
eof?
يُعيد القيمة true إن كان مجرى د/خ ios في نهاية الملف، ما يعني أنه لا لم تعد هناك بيانات أخرى للقراءة. يجب أن يكون المجرى مفتوحًا في وضعية القراءة أو سيُرفع استثناء IOError.
external_encoding
يُعيد الترميز Encoding الذي يمثل ترميز الملف. إن كان مجرى د/خ io في وضع الكتابة ولم يُحدّد أي ترميز، فستعاد nil.
fcntl
يوفر آلية لإصدار أوامر منخفضة المستوى للتحكم في مجاري د/خ I/O الموجهة بالملفات، أو الاستعلام عنها. الوسائط والنتائج تعتمد على النظام المُستخدم. إن كان الوسيط arg (انظر فقرة البنية العامة) عددًا، فستُمرر قيمته مباشرةً. وإن كان سلسلة نصية، فستُفسر على أنها تسلسل ثنائي من البايتات (قد يكون التابع Array#pack طريقة مفيدة لإنشاء مثل هذه السلسلة). على منصات اليونيكس، راجع صفحة fcntl(2) لمزيد من التفاصيل. هذا التابع ليس مُتاح على جميع المنصات.
fdatasync
يكتب على الفور جميع البيانات المخزنة في مجرى د/خ ios في القرص.
fileno
يُعيد عددا صحيحا يمثل واصف الملف الرقمي لمجرى د/خ ios.
flush
يرسل (Flushes) أي بيانات مخزنة في مجرى د/خ ios إلى نظام التشغيل (لاحظ أن هذا لا يشمل إلا التخزين المؤقت الداخلي لروبي؛ وقد يقوم نظام التشغيل بتخزين البيانات أيضًا).
fsync
يكتب على الفور جميع البيانات المخزنة في مجرى د/خ ios في القرص. لاحظ أن fsync يختلف عن استخدام IO#sync=. حيث يضمن الأخير أن تُرسل البيانات من المخازن المؤقتة (buffers) لروبي، ولكنه لا يضمن أنّ نظام التشغيل سيكتبها بالفعل في القرص.
getbyte
يحصل على البايت (8-bit byte) الموالي (0..255) من مجرى د/خ ios. ويُعيد nil إن استُدعي عند نهاية الملف.
getc
يقرأ سلسلة نصية مُؤلفة من حرف واحد من مجرى د/خ ios. ويُعيد nil إن استُدعي عند نهاية الملف.
gets
يقرأ "السطر" الموالي من مجرى د/خ. السطور مفصولة بواسطة sep. إن كان الفاصل يساوي nil، فسيقرأ المحتويات بالكامل، أما إن كان الفاصل معدوم الطول، فستُقرؤ فقرة في كل مرة من مجرى الإدخال (تُفصل الفقرات بسطرين منفصلين). يجب أن يكون المجرى مفتوحًا في وضعية القراءة أو سيُرفع استثناء IOError. سيُعاد السطر المقروء، وستُعين قيمته إلى $_. ستعاد القيمة nil إن تم استُدعي عند نهاية الملف. إن كان الوسيط الأول عددًا صحيحًا أو إن أعطي الوسيط الاختياري الثاني، فلن تكون السلسلة النصية المعادة أطول من القيمة المحددة من حيث عدد البايتات (bytes).
inspect
يُعيد سلسلة نصية تصف مجرى د/خ الذي استُدعي معه IO.
internal_encoding
يعيد الترميز Encoding الخاص بالسلسلة النصية الداخلية في حالة تحديد التحويل. على خلاف ذلك سيُعيد nil.
ioctl
يوفر آلية لإصدار أوامر منخفضة المستوى للتحكم في أجهزة مجاري د/خ I/O، أو الاستعلام عنها. الوسائط والنتائج تعتمد على النظام المُستخدم. إن كان الوسيط arg (انظر فقرة البنية العامة) عددًا، فستُمرر قيمته مباشرةً. وإن كان سلسلة نصية، فستُفسر على أنها تسلسل ثنائي من البايتات لاستخدامه في منصات اليونيكس، راجع صفحة ioctl(2) لمزيد من التفاصيل. غير متاح على جميع المنصات.
isatty
يُعيد القيمة true إن كان مجرى د/خ ios مربوطا بجهاز طرفي (tty)، أو يعيد false خلاف ذلك.
lineno
يعيد رقم السطر الحالي في مجرى د/خ ios. يجب أن يكون المجرى مفتوحا في وضعية القراءة. يحسب التابع lineno عدد المرات التي يتم فيها استدعاء gets بدلاً من عدد السطور الجديدة التي تمت مصادفتها. ستختلف القيمتان إن استُدعي gets مع فاصل آخر غير فاصل السطر الجديد.
lineno=
يعيّن يدويًا رقم السطر الحالي ويعطيه القيمة المحددة. لن تُحدّث $. إلا عند القراءة التالية.
lines
مرادف مُتجاوز للتابع each_line.
pid
يُعيد معرف العملية (PID) الخاص بالعملية الفرعية (child process) تامرتبطة بمجرى د/خ ios. سيتم تعيينه بواسطة التابع IO.popen.
pos
يُعيد الإزاحة (offset) الحالية (بالبايت) في مجرى د/خ ios.
pos=
يسعى إلى التموضع عند الإزاحة المحددة (بالبايت) في مجرى د/خ ios. ليس مضمونا أن يكون التموضع صحيحًا عندما يكون مجرى د/خ ios في الوضع النصي (textmode).
pread
يقرأ maxlen (انظر فقرة البنية العامة) بايت من مجرى د/خ ios باستخدام استدعاء النظام pread، ثم يُعيدها كسلسلة نصية من غير تعديل إزاحة (offset) الواصف الأساسي. هذا مفيد مقارنة بالجمع بين #seek و #read في كونه ذريًا (atomic)، مما يسمح لعدة مهام فرعية/عمليات بالتشارك في نفس مجرى د/خ IO لقراءة الملف في مواضع مختلفة. هذا سيتجاوز أي مساحة تخزين مؤقت للمستخدمين من طبقة مجرى د/خ IO. في حال إعطاء الوسيط الاختياري outbuf (انظر فقرة البنية العامة)، فينبغي أن يشير إلى سلسلة نصية String، والتي ستتلقى البيانات. سيُطلق استثناء SystemCallError عند الخطأ، أو EOFError عند نهاية الملف، أو NotImplementedError إن لم يكن نظام التشغيل يدعم استدعاء النظام.
يكتب الكائن(ات) المعطاة في مجرى د/خ ios. ثم يُعيد nil.
printf
ينسق ويكتب في مجرى د/خ ios، حيث يحول الوسائط المعطاة وفق سلسلة التنسيق الممررة format_string (انظر فقرة البنية العامة). انظر صفحة Kernel#sprintf لمزيد من التفاصيل.
putc
إن كان الوسيط المعطى obj (انظر فقرة البنية العامة) عددًا Numeric، فسيكتب الحرف الذي يكون رمزه هو البايت الأقل دلال (least-significant byte) من obj. وإن كان obj سلسلة نصية String، فسيكتب أول حرف من obj في مجرى د/خ ios. خلاف ذلك، سيُطلق الاستثناء TypeError.
puts
يكتب الكائن(اات) المعطى في مجرى د/خ ios. ويكتب سطرًا جديدا بعد أي سطر لا ينتهي بالفعل بمحرف السطر الجديد. ثم يعيد nil.
pwrite
يكتب السلسلة النصية المعطاة (انظر فقرة البنية العامة) في مجرى د/خ ios عند موضع الإزاحة offset باستخدام استدعاء النظام pwrite (). هذا مفيد مقارنة بالجمع بين #seek و #write في كونه ذريًا (atomic)، مما يسمح لعدة مهام فرعية/عمليات بالتشارك في نفس مجرى د/خ IO لقراءة الملف من مواضع مختلفة. هذا سيتجاوز أي مساحة تخزين مؤقت للمستخدمين من طبقة مجرى د/خ IO. سيعيد عدد البايتات المكتوبة. وسيُطلق الاستثناء SystemCallError في حال حدوث خطأ، أو NotImplementedError إذا لم يكن نظام الشغيل يدعم استدعاء النظام.
read
يقرأ length بايتًا (انظر فقرة البنية العامة) من مجرى د/خ.
read_nonblock
يقرأ على الأكثر maxlen (انظر فقرة البنية العامة) بايتًا من مجرى د/خ ios باستخدام استدعاء النظام read(2) بعد تعيين O_NONBLOCK في واصف الملف (file descriptor) الأساسي.
readbyte
يقرأ البايت كما يفعل التابع IO#getbyte، إلا أنه يُطلق الاستثناء EOFError على نهاية الملف.
readchar
يقرأ سلسلة نصية مؤلفة من حرف واحد من مجرى د/خ ios. ويطلق الاستثناء EOFError عند نهاية الملف.
readline
يقرأ سطرًا كما يفعل التابع IO#gets، إلا أنه يُطلق الاستثناء EOFError عند نهاية الملف.
readlines
يقرأ كل الأسطر الموجودة في مجرى د/خ ios، ثم يعيدها في مصفوفة. يتم فصل الأسطر بالوسيط الاختياري sep (انظر فقرة البنية العامة). إن كان الوسيط sep يساوي nil، فسسيُعاد بقية المجرى كتسجيلة (record) واحدة. إن كان الوسيط الأول عددًا صحيحًا، أو إن أعطي الوسيط الاختياري الثاني، فلن تكون السلسلة النصية المعادة أطول من حيث عدد البايتات من القيمة المحددة. يجب أن يكون المجرى مفتوحًا في وضعية القراءة أو سيُطلق استثناء IOError.
readpartial
يقرأ maxlen (انظر فقرة البنية العامة) بايتًا على الأكثر من مجرى د/خ. لا يقوم بالتعطيل إلا في حال لم يكن في مجرى د/خ ios أي بيانات متوفرة آنيًا. لن يقوم بالتعطيل في حالة توفر بعض البيانات.
reopen
يربط بين مجرى د/خ الذي استُدعي معه ios وبين مجرى د/خ المعطى في other_IO (انظر فقرة البنية العامة)، أو مجرى جديد يُفتح من المسار path. قد يؤدي هذا إلى تغيير الصنف الفعلي لهذا المجرى ديناميكيًا.
rewind
يُموضِع مجرى د/خ الذي استُدعي معه ios عند بداية الإدخال، مع تعيين lineno عند القيمة صفر.
seek
يسعى إلى التموضع عند الإزاحة المعطاة anInteger في مجرى د/خ وفقا لقيمة whence (انظر فقرة البنية العامة):
set_encoding
في حال تمرير وسيط واحد، فستوسم السلسلة النصية المقروءة من مجرى د/خ وفق الترميز المحدد. إن كان الترميز على هيئة حرفي ترميز مفصولين بنقطتين رأسيتين "A: B"، فستُحوّل السلسلة النصية المقروءة من الترميز A (الترميز الخارجي) إلى الترميز B (الترميز الداخلي)، ثم توسم بـ B. في حال إعطاء وسيطين، فيجب أن يكونا كائني ترميز، أو اسمي ترميز، حيث يمثل أولها الترميز الخارجي، فيما يمثل ثانيهما الترميز الداخلي. في حال تحديد الترميز الخارجي والترميز الداخلي، فسيحدد الوسيط الاختياري opt خيارات التحويل.
stat
يُعيد معلومات الحالة لمجرى د/خ الذي استُدعي معه ios على هيئة كائن من النوع File::Stat.
sync
يُعيد قيمة راية وضع المزامنة "sync mode" الحالية لمجرى د/خ ios. عندما تكون قيمة وضع المزامنة true، فسيتم إرسال كل المخرجات فورًا إلى نظام التشغيل، ولن يُخزّن مؤقتًا من قبل روبي داخليًا. انظر أيضا صفحة IO#fsync.
sync=
يضبط قيمة راية وضع المزامنة “sync mode' عند إحدى القيمتين true أو false. عندما تكون قيمة وضع المزامنة true، فسيتم إرسال كل المخرجات فورًا إلى نظام التشغيل، ولن تُخزن (buffered) داخليًا. يُعيد الحالة الجديدة. انظر أيضا صفحة IO#fsync.
sysread
يقرأ maxlen (انظر فقرة البنية العامة) بايتًا من مجرى د/خ الذي استُدعي معه ios باستخدام قراءة منخفضة المستوى (low-level read) ويُعيدها كسلسلة نصية. لا تخلط هذا التابع مع التوابع الأخرى التي تقرأ من مجرى د/خ ios، أو قد تحصل على نتائج غير متوقعة.
sysseek
يسعى إلى التموضع عند الإزاحة المعطاة offset (انظر فقرة البنية العامة) وفقا لقيمة whence (انظر IO#seek للتعرف على القيم الممكنة للوسيط whence). يُعيد الإزاحة الجديدة للملف.
syswrite
يكتب السلسلة النصية المعطاة في مجرى د/خ الذي استُدعي معه ios باستخدام كتابة منخفض المستوى (low-level write). ثم يعيد عدد البايتات المكتوبة. لا تخلط هذا التابع مع التوابع الأخرى التي تكتب في مجرى د/خ ios، أو قد تحصل على نتائج غير متوقعة. يُطلق استثناء SystemCallError عند حدوث خطأ.
tell
يُعيد الإزاحة الحالية (بالبايت) في مجرى د/خ ios.
to_i
to_io
يعيد مجرى د/خ الذي استُدعي معه ios.
tty?
يُعيد القيمة true إن كان مجرى د/خ ios مربوطا بطرفية (tty)، أو يعيد false خلاف ذلك.
ungetbyte
يدفع (Pushes back) البايتات (التي تم تمريرها كوسيط) إلى مجرى د/خ الذي استُدعي معه ios، بحيث ستعيدها القراءة التالية من المخزن المؤقت (buffer). لا يمكنك أن تدفع إلا بايتًا واحدا فقط قبل عملية القراءة اللاحقة (أي، لن تتمكن من قراءة إلا آخر بايت من البايتات التي دفتعها). ليس له أي تأثير مع القراءات غير التخزينية (unbuffered reads) (مثل IO#sysread).
ungetc
يدفع حرفا واحدا (المُمرر كوسيط) في مجرى د/خ الذي استُدعي معه ios، بحيث ستعيدها القراءة التالية من المخزن المؤقت (buffer). لا يمكنك أن تدفع إلا حرف واحد فقط قبل عملية القراءة اللاحقة (أي، لن تتمكن من قراءة إلا آخر حرف من الحروف التي دفتعها). ليس له أي تأثير مع القراءات غير التخزينية (unbuffered reads) (مثل IO#sysread).
write
يكتب السلاسل النصية المعطاة في مجرى د/خ ios. يجب أن يكون المجرى مفتوحا في وضعية للكتابة. سيتم تحويل الوسائط غير النصية إلى سلسلة نصية باستخدام to_s. يُعيد عدد البايتات المكتوبة في الإجمال.
write_nonblock
يكتب السلسلة النصية المعطاة في ios باستخدام استدعاء النظام write(2) بعد تعيين O_NONBLOCK لواصف الملف (file descriptor) الأساسي.