کتابخانه‌ی استاندارد · سیستم و ابزار

سیستم پرونده fs

خواندن و نوشتن پرونده، اطلاعات، زمان‌ها و مجوزها، رونوشت و جابه‌جایی، و چکیده‌ی MD5 و SHA.

واردسازی سیستم پرونده

نام آرگومان‌ها شناسه‌ی خود کد است و معادل فارسی ندارد؛ گونه‌ها، کلیدواژه‌ها و نام بسته‌ها با معادل فارسی نوشته می‌شوند.

بسته‌ی سیستم پرونده هر چیزی را که برای کار با یک پرونده لازم دارید در خود دارد: خواندن کامل یا خط‌به‌خط، نوشتن، افزودن، جایگزینی امن، رونوشت، جابه‌جایی و حذف، دانستن اندازه و زمان‌ها و مجوزها، تغییر مجوز، چکیده‌ی پرونده و حدس نوع MIME. یک واردسازی کافی است: واردسازی سیستم پرونده و بعد سیستم پرونده.خواندن متن(مسیر). برای پوشه‌ها از سیستم پرونده.پوشه، برای مسیرها از سیستم پرونده.مسیر و برای خواندن تکه‌تکه‌ی پرونده‌ی بزرگ از تابع‌های دستگیره‌ی ورودی خروجی استفاده کنید. بسته‌ی ساده‌تر سیستم عامل خواندن کامل پرونده، فهرست پوشه و بررسی وجود را پوشش می‌دهد.

بسته‌ی قدیمی سیستم پرونده.پرونده هنوز کار می‌کند اما منسوخ است: هر فراخوانی را به سیستم پرونده می‌فرستد. در کد تازه واردسازی سیستم پرونده و سیستم پرونده.خواندن متن بنویسید، نه واردسازی سیستم پرونده.پرونده و پرونده.خواندن متن.

نوشتن‌ها تعداد بایت‌های نوشته‌شده یا -۱ را برمی‌گردانند. خواندن‌ها وقتی پرونده باز نشود متن خالی می‌دهند، درست مثل پرونده‌ی خالی؛ وقتی این فرق مهم است وجود دارد را بپرسید.

اشتباه‌های رایج:

  • دودویی‌امن دانستن این بسته. هر خواندن و نوشتنی از یک رشته می‌گذرد که در نخستین بایت صفر تمام می‌شود، پس خواندن همه، خواندن بایت‌ها، نوشتن بایت‌ها و تابع‌های چکیده پرونده‌ی دودویی را کوتاه می‌کنند. برای تصویر، بایگانی و هر داده‌ی دودویی دیگر خواندن پرونده دودویی و نوشتن پرونده دودویی از بسته‌ی بایگانی را به کار ببرید که اشاره‌گر و طول را جابه‌جا می‌کنند، و برای چکیده شکل‌های اشاره‌گری بسته‌ی رمزنگاری مثل شا۲۵۶ بایت را.
  • انتظار این‌که جابجایی از دیسکی به دیسک دیگر برود. این تابع تغییر نام است و میان دو سیستم پرونده شکست می‌خورد؛ پوشه.جابجایی به رونوشت برمی‌گردد، یا خودتان رونوشت بگیرید و حذف کنید.
  • گمان این‌که نوشتن اتمی مجوزهای پرونده‌ی قدیمی را نگه می‌دارد. پرونده‌ی تازه‌ای می‌نویسد که مجوزهای پیش‌فرض را می‌گیرد؛ پرونده‌ای که به 0o600 تنگ کرده بودید دوباره خواندنی می‌شود، مگر پس از هر ذخیره تغییر مجوز را صدا بزنید.
  • به معنای «پرونده است» گرفتن وجود دارد. برای پوشه هم درست است؛ آن را با پوشه.پوشه است همراه کنید.

زمان‌ها ثانیه‌های کامل از آغاز سال ۱۹۷۰ (زمان یونیکس) هستند، به شکل صحیح۶۴. هر تابع وقتی مسیر وجود نداشته باشد یا سیستم نتواند جواب بدهد -1 برمی‌گرداند.

مجوزها را به شکل هشت‌هشتی بنویسید، مثل 0o644 (مالک می‌خواند و می‌نویسد، بقیه فقط می‌خوانند). مجوزها همان رقم‌ها را به شکل یک عدد معمولی برمی‌گرداند، مثل 644، تا راحت خوانده شود. این دو یک عدد نیستند (0o644 برابر ۴۲۰ است)، پس نتیجه‌ی مجوزها را بی‌تغییر به تغییر مجوز ندهید.

خواندن پرونده‌ی تنظیمات خط به خط

خواندن خط‌ها پرونده را در شکست‌های خط جدا می‌کند و \r انتهای خط را هم برمی‌دارد، پس پرونده‌ای که در ویندوز ذخیره شده همان‌طور خوانده می‌شود که پرونده‌ی لینوکسی. با این کار پرونده‌های ساده‌ی کلید = مقدار آسان می‌شوند: هر خط را بپیرایید، خط‌های خالی و توضیح‌ها را رد کنید و در اولین = جدا کنید.

fs-guide-config.salam
واردسازی سیستم پرونده
واردسازی رشته

تابع ریشه:
    سیستم پرونده.نوشتن متن("برنامه.conf"، "# تنظیمات فروشگاه\nname = فروشگاه سر کوچه\n\nport = 8080\ncurrency = IRR\n")
    تنظیمات := نگاشت {} برگردان نگاشت<رشته، رشته>
    هر سطر در سیستم پرونده.خواندن خط‌ها("برنامه.conf"):
        ت := سطر.پیراست()
        اگر ت.طول() == ۰ یا رشته.شروع با(ت، "#"): گذر پایان
        جای مساوی := رشته.اندیس(ت، "=")
        اگر جای مساوی < ۰: گذر پایان
        تنظیمات.درج(ت.زیررشته(۰، جای مساوی).پیراست()، ت.زیررشته(جای مساوی + ۱، ت.طول() - جای مساوی - ۱).پیراست())
    پایان
    سرچاپ تنظیمات.اندازه()، "تنظیم"
    سرچاپ "نام:"، تنظیمات.بگیر("name")
    سرچاپ "درگاه:"، تنظیمات.بگیر("port")
    سیستم پرونده.حذف("برنامه.conf")
پایان
خروجی3 تنظیم نام: فروشگاه سر کوچه درگاه: 8080

برای قالبی با بخش‌بندی، نقل‌قول یا ساختار تو در تو، یک تجزیه‌گر واقعی مثل تامل، جیسون یا پرونده محیط را به کار ببرید.

افزودن به پرونده‌ی گزارش

افزودن پرونده را باز می‌کند، متن را به انتهایش اضافه می‌کند و دوباره می‌بندد، و در اولین فراخوانی پرونده را می‌سازد. هر فراخوانی یک باز و بسته کردن جداست که برای یک خط گاه‌به‌گاه خوب است. برای گزارشی پرکار، پرونده را یک بار با بازکردن(پ، "ab") باز کنید، با ورودی خروجی.نوشتن بنویسید و در پایان بستن را صدا بزنید.

fs-guide-log.salam
واردسازی سیستم پرونده

تابع ثبت(سطر: رشته):
    سیستم پرونده.افزودن("برنامه.log"، سطر.پیوست("\n"))
پایان

تابع ریشه:
    ثبت("شروع شد")
    ثبت("۳ سفارش بارگذاری شد")
    ثبت("صورت‌حساب ۱۰۴۲ فرستاده شد")
    ثبت("متوقف شد")
    سطرها := سیستم پرونده.خواندن خط‌ها("برنامه.log")
    سرچاپ "گزارش"، سطرها.طول()، "خط و"، سیستم پرونده.اندازه("برنامه.log")، "بایت دارد"
    سرچاپ "دو خط آخر:"
    ناپایا ی := سطرها.طول() - ۲
    تا ی < سطرها.طول():
        سرچاپ " "، سطرها.بگیر(ی)
        ی++
    پایان
    سیستم پرونده.حذف("برنامه.log")
پایان
خروجیگزارش 4 خط و 115 بایت دارد دو خط آخر: صورت‌حساب ۱۰۴۲ فرستاده شد متوقف شد

بررسی سالم رسیدن پرونده

صفحه‌های دانلود اغلب کنار هر پرونده چکیده‌ی SHA-256 آن را منتشر می‌کنند. چکیده‌ی نسخه‌ی خودتان را با هش شا۲۵۶ حساب کنید و دو مقدار را مقایسه کنید: تغییر حتی یک بایت چکیده‌ی کاملاً متفاوتی می‌دهد. هش ام‌دی۵ و هش شا۱ برای فهمیدن تغییرهای ناخواسته، مثلاً به عنوان کلید حافظه‌ی پنهان، خوب‌اند؛ اما هر کسی می‌تواند عمداً دو پرونده‌ی متفاوت با MD5 یا SHA-1 یکسان بسازد، پس در برابر مهاجم به آن‌ها اعتماد نکنید.

fs-guide-checksum.salam
واردسازی سیستم پرونده

تابع سالم است(پ: رشته): منطقی:
    انتظار := سیستم پرونده.خواندن متن(پ.پیوست(".sha256")).پیراست()
    برگشت سیستم پرونده.هش شا۲۵۶(پ) == انتظار
پایان

تابع ریشه:
    سیستم پرونده.نوشتن بایت‌ها("انتشار.tar"، "pretend this is a release archive")
    سیستم پرونده.نوشتن متن("انتشار.tar.sha256"، سیستم پرونده.هش شا۲۵۶("انتشار.tar").پیوست("\n"))
    سرچاپ "سالم:"، سالم است("انتشار.tar")
    سیستم پرونده.افزودن("انتشار.tar"، "!")
    سرچاپ "پس از تغییر:"، سالم است("انتشار.tar")
    سیستم پرونده.حذف("انتشار.tar")
    سیستم پرونده.حذف("انتشار.tar.sha256")
پایان
خروجیسالم: true پس از تغییر: false

تابع‌های چکیده اول پرونده را در یک رشته می‌خوانند و رشته‌ی سلام در اولین بایت صفر تمام می‌شود. برای پرونده‌های متنی این مهم نیست. اما پرونده‌ی دودویی‌ای که بایت صفر دارد، که بیشتر بایگانی‌ها و تصویرها دارند، فقط تا همان بایت چکیده می‌شود؛ چنین پرونده‌هایی را با sha256sum سیستم یا با تابع‌های بافری رمزنگاری مثل شا۲۵۶ بایت بررسی کنید. همین محدودیت برای خواندن همه، خواندن متن، خواندن بایت‌ها و نوشتن بایت‌ها هم هست.

ذخیره بدون از دست دادن نسخه‌ی قبلی

نوشتن اتمی محتوای تازه را در نام.tmp کنار پرونده‌ی مقصد می‌نویسد و بعد در یک گام آن را جای مقصد می‌گذارد. برنامه‌ای که در میانه‌ی کار از کار بیفتد یا پرونده‌ی قدیمی را باقی می‌گذارد یا پرونده‌ی تازه را، هرگز نیمی از هر کدام. داده را پیش از آن روی دیسک نمی‌نشاند، پس پس از قطع برق پرونده‌ای که لحظه‌ای پیش ذخیره شده روی برخی سیستم‌های پرونده هنوز ممکن است از دست برود، و دو برنامه که هم‌زمان یک پرونده را ذخیره کنند نام .tmp یکسانی دارند. رونوشت گرفتن از پرونده‌ی قدیمی در .bak پیش از آن، یک نسخه‌ی قبلی را هم نگه می‌دارد. اگر پوشه وجود نداشته باشد، نوشتن اتمی مقدار -1 برمی‌گرداند و پیامش را در خطا می‌گذارد.

fs-guide-save.salam
واردسازی سیستم پرونده
واردسازی سیستم عامل.خطا

تابع ذخیره(پ: رشته، داده: رشته): منطقی:
    اگر سیستم پرونده.وجود دارد(پ): سیستم پرونده.کپی(پ، پ.پیوست(".bak")) پایان
    اگر سیستم پرونده.نوشتن اتمی(پ، داده) != ۰:
        سرچاپ "ذخیره نشد:"، خطا.پیام آخرین خطا()
        برگشت نادرست
    پایان
    برگشت درست
پایان

تابع ریشه:
    ذخیره("نمایه.json"، "{\"name\": \"سارا\"}")
    ذخیره("نمایه.json"، "{\"name\": \"سارا\", \"city\": \"تبریز\"}")
    سرچاپ "نسخه‌ی فعلی:"، سیستم پرونده.خواندن متن("نمایه.json")
    سرچاپ "پشتیبان:"، سیستم پرونده.خواندن متن("نمایه.json.bak")
    سرچاپ "پرونده‌ی موقت ماند:"، سیستم پرونده.وجود دارد("نمایه.json.tmp")
    ذخیره("پوشه-ناموجود/نمایه.json"، "{}")
    سیستم پرونده.حذف("نمایه.json")
    سیستم پرونده.حذف("نمایه.json.bak")
پایان
خروجینسخه‌ی فعلی: {"name": "سارا", "city": "تبریز"} پشتیبان: {"name": "سارا"} پرونده‌ی موقت ماند: false ذخیره نشد: atomic write failed

فرستادن پرونده با نوع درست

سرور وب باید همراه هر پرونده یک Content-Type بفرستد. نوع مایم آن را فقط از روی پسوند و بدون توجه به کوچکی و بزرگی حروف انتخاب می‌کند و نوع‌های رایج وب، تصویر، صدا، ویدیو و بایگانی را می‌شناسد؛ هر چیز دیگری application/octet-stream است که مرورگر به جای نمایش، دانلودش می‌کند. پسوند نقطه و شکل اصلی حروف را نگه می‌دارد و برای نامی که پسوند ندارد خالی است.

fs-guide-mime.salam
واردسازی سیستم پرونده

تابع ریشه:
    هر نام در ["index.html"، "app.js"، "logo.SVG"، "photo.jpeg"، "داده.json"، "یادداشت"، "backup.7z"]:
        پسوند := سیستم پرونده.پسوند(نام)
        اگر پسوند == "": سرچاپ نام، "(بدون پسوند)"، سیستم پرونده.نوع مایم(نام)
        وگرنه: سرچاپ نام، پسوند، سیستم پرونده.نوع مایم(نام)
        پایان
    پایان
پایان
خروجیindex.html .html text/html app.js .js text/javascript logo.SVG .SVG image/svg+xml photo.jpeg .jpeg image/jpeg داده.json .json application/json یادداشت (بدون پسوند) application/octet-stream backup.7z .7z application/octet-stream

سرور HTTP معمولاً بهتر است مایم را به کار ببرد: رده مایم در آن بسته به نوع‌های متنی ; charset=utf-8 اضافه می‌کند و قلم‌های وب را هم می‌شناسد، و خود بسته سرآیند Content-Type و بدنه‌های چندبخشی را هم تجزیه می‌کند.

خصوصی نگه داشتن پرونده‌ی محرمانه

پرونده‌ی تازه مجوز پیش‌فرض سیستم را می‌گیرد، معمولاً 644، یعنی همه‌ی حساب‌های دستگاه می‌توانند آن را بخوانند. برای توکن، کلید و گذرواژه، پرونده را بنویسید و بعد مجوزش را به 0o600 محدود کنید. دو شکل نوشتن را با هم اشتباه نکنید: تغییر مجوز عدد هشت‌هشتی می‌گیرد (0o600) و مجوزها همان رقم‌ها را به شکل یک عدد معمولی برمی‌گرداند (600). برای همین در نمونه‌ی زیر م % ۱۰۰ == ۰ یعنی گروه و دیگران هیچ دسترسی‌ای ندارند.

fs-guide-private.salam
واردسازی سیستم پرونده

تابع ریشه:
    سیستم پرونده.نوشتن متن("توکن.txt"، "s3cr3t")
    سیستم پرونده.تغییر مجوز("توکن.txt"، 0o644)
    سرچاپ "پیش از تغییر:"، سیستم پرونده.مجوزها("توکن.txt")
    سیستم پرونده.تغییر مجوز("توکن.txt"، 0o600)
    م := سیستم پرونده.مجوزها("توکن.txt")
    سرچاپ "پس از تغییر:"، م
    اگر م % ۱۰۰ == ۰:
        سرچاپ "فقط مالک می‌تواند آن را بخواند"
    پایان
    سیستم پرونده.حذف("توکن.txt")
پایان
خروجیپیش از تغییر: 644 پس از تغییر: 600 فقط مالک می‌تواند آن را بخواند

خواندن رقم‌های مجوز

سه رقم به ترتیب مال مالک، گروه و بقیه‌اند. درون هر رقم، ۴ یعنی خواندن، ۲ یعنی نوشتن و ۱ یعنی اجرا، و خود رقم جمع این‌هاست:

رقمحروفمعنا
7rwxخواندن، نوشتن و اجرا
6rw-خواندن و نوشتن
5r-xخواندن و اجرا
4r--فقط خواندن
0---هیچ

این نمونه عدد را به همان حروفی تبدیل می‌کند که ls -l چاپ می‌کند. اسکریپت تا وقتی بیت اجرا برای مالکش روشن نباشد (0o755 یا 0o700) در پوسته اجرا نمی‌شود، و پوشه هم بدون این بیت باز نمی‌شود.

fs-guide-rwx.salam
واردسازی سیستم پرونده

تابع حرف‌ها(رقم: صحیح): رشته:
    ناپایا خروجی := ""
    اگر رقم >= ۴: خروجی += "r" وگرنه: خروجی += "-" پایان
    اگر رقم % ۴ >= ۲: خروجی += "w" وگرنه: خروجی += "-" پایان
    اگر رقم % ۲ == ۱: خروجی += "x" وگرنه: خروجی += "-" پایان
    برگشت خروجی
پایان

تابع نمایش(م: صحیح): رشته:
    برگشت حرف‌ها(م / ۱۰۰) + حرف‌ها(م / ۱۰ % ۱۰) + حرف‌ها(م % ۱۰)
پایان

تابع ریشه:
    سیستم پرونده.نوشتن متن("استقرار.sh"، "echo deploying\n")
    هر حالت در [0o755 ، 0o750 ، 0o644 ، 0o600]:
        سیستم پرونده.تغییر مجوز("استقرار.sh"، حالت)
        م := سیستم پرونده.مجوزها("استقرار.sh")
        سرچاپ م، نمایش(م)
    پایان
    سیستم پرونده.حذف("استقرار.sh")
پایان
خروجی755 rwxr-xr-x 750 rwxr-x--- 644 rw-r--r-- 600 rw-------

فقط آن‌چه را که عوض شده دوباره بسازید

ابزارهای ساخت مثل make با زمان تغییر تصمیم می‌گیرند: خروجی وقتی کهنه است که منبعش بعد از نوشته شدن خروجی تغییر کرده باشد. برای مسیری که وجود ندارد زمان تغییر مقدار -1 برمی‌گرداند و نمونه آن را «باید ساخت» می‌خواند. زمان‌ها به ثانیه‌ی کامل‌اند، پس منبع و خروجی‌ای که در یک ثانیه نوشته شوند به‌روز حساب می‌شوند. این‌جا همین پاسخ درست است، چون خروجی بعد از منبع نوشته شده است.

fs-guide-rebuild.salam
واردسازی سیستم پرونده

تابع ساخت لازم است(منبع: رشته، خروجی: رشته): منطقی:
    زمان ساخت := سیستم پرونده.زمان تغییر(خروجی)
    اگر زمان ساخت < ۰: برگشت درست پایان
    برگشت سیستم پرونده.زمان تغییر(منبع) > زمان ساخت
پایان

تابع ریشه:
    سیستم پرونده.نوشتن متن("صفحه.md"، "# سلام\n")
    سرچاپ "اجرای اول، ساخت لازم است:"، ساخت لازم است("صفحه.md"، "صفحه.html")
    سیستم پرونده.نوشتن متن("صفحه.html"، "<h1>سلام</h1>\n")
    سرچاپ "پس از ساخت، ساخت لازم است:"، ساخت لازم است("صفحه.md"، "صفحه.html")
    سیستم پرونده.حذف("صفحه.html")
    سرچاپ "خروجی پاک شد، ساخت لازم است:"، ساخت لازم است("صفحه.md"، "صفحه.html")
    سیستم پرونده.حذف("صفحه.md")
پایان
خروجیاجرای اول، ساخت لازم است: true پس از ساخت، ساخت لازم است: false خروجی پاک شد، ساخت لازم است: true

نکته‌های سیستم عامل

  • زمان ایجاد جایی که سیستم پرونده زمان ساخت را نگه نمی‌دارد 0 است، که در لینوکس رایج است. اگر مقداری می‌خواهید که همیشه باشد، زمان تغییر را به کار ببرید.
  • در لینوکس، مک و BSD تابع‌های زمان و مجوزها فرمان stat سیستم را از راه پوسته و با مسیرِ در نقل‌قول اجرا می‌کنند. برای چند پرونده سریع است، اما در حلقه‌ای روی هزاران پرونده، اجرای این همه فرایند جمع می‌شود. تغییر مجوز مستقیم سیستم را صدا می‌زند.
  • ویندوز بیت‌های مجوز یونیکس را ندارد و فقط یک پرچم «فقط خواندنی» دارد؛ پس تغییر مجوز فقط همان پرچم را عوض می‌کند و مجوزها برای پرونده‌ی فقط خواندنی ۲۹۲ (0o444) و در غیر این صورت ۴۳۸ (0o666) برمی‌گرداند: مقدار هشت‌هشتی، نه رقم‌هایی که در یونیکس می‌دهد. منطق مجوزها را برای یونیکس بنویسید و همان‌جا آزمایش کنید.

کدام تابع برای کدام کار

کارتابع
خواندن یک‌جای پرونده‌ی متنی کوچکخواندن متن، یا خواندن خط‌ها برای وکتوری از خط‌ها
خواندن فقط ابتدای پروندهخواندن بایت‌ها
جایگزین کردن محتوای پروندهنوشتن متن، یا نوشتن اتمی وقتی پرونده مهم است
افزودن به انتهای پروندهافزودن
کار تکه‌به‌تکه با پرونده‌ی بزرگبازکردن، بعد تابع‌های ورودی خروجی، بعد بستن
اندازه، زمان‌ها و مجوزها با یک فراخوانیوضعیت
رونوشت، جابه‌جایی یا حذفکپی، جابجایی (یا تغییر نام)، حذف
بررسی یک دانلودهش شا۲۵۶
نوع محتوا برای پاسخ وبنوع مایم

گونه‌ها

اطلاعات پرونده FileInfo

ساختار اطلاعات پرونده
اطلاعات یک پرونده.
نامانگلیسیگونهتوضیح
اندازهsizeصحیح۶۴ = 0اندازه بر حسب بایت.
زمان تغییرmod_timeصحیح۶۴ = 0زمان آخرین تغییر.
زمان دسترسیaccessed_timeصحیح۶۴ = 0زمان آخرین دسترسی.
زمان ایجادcreated_timeصحیح۶۴ = 0زمان ایجاد.
مجوزهاpermissionsصحیح = 0مجوزها، با رقم‌های هشت‌هشتی مثل 644.
وجود داردexistsمنطقی = نادرستاگر مسیر وجود داشته باشد (پوشه هم حساب است) درست است؛ اگر نباشد بقیه‌ی فیلدها ۰اند.
fs-Stat.salam
واردسازی سیستم پرونده

تابع ریشه:
    سیستم پرونده.نوشتن متن("عکس.png"، "PNG")
    و۱ := سیستم پرونده.وضعیت("عکس.png")
    سرچاپ و۱.وجود دارد، و۱.اندازه، و۱.زمان تغییر > ۰، و۱.مجوزها > ۰
    سرچاپ سیستم پرونده.اندازه("عکس.png")، سیستم پرونده.وجود دارد("عکس.png")
    سرچاپ سیستم پرونده.زمان تغییر("عکس.png") > ۰، سیستم پرونده.زمان دسترسی("عکس.png") > ۰، سیستم پرونده.زمان ایجاد("عکس.png") >= ۰
    سیستم پرونده.تغییر مجوز("عکس.png"، 0o600)
    سرچاپ سیستم پرونده.مجوزها("عکس.png")
    سرچاپ سیستم پرونده.پسوند("عکس.png")، سیستم پرونده.نوع مایم("عکس.png")، سیستم پرونده.نوع مایم("نامه.pdf")
    سرچاپ سیستم پرونده.وضعیت("نیست.txt").وجود دارد
پایان
خروجیtrue 3 true true 3 true true true true 600 .png image/png application/pdf false

فراداده پرونده FileMeta

ساختار فراداده پرونده
نامانگلیسیگونهتوضیح
مسیرpathرشته = ""
وجود داردexistsمنطقی = نادرست
پرونده استis_fileمنطقی = نادرست
پوشه استis_dirمنطقی = نادرست
پیوند استis_linkمنطقی = نادرست
اندازهsizeصحیح۶۴ = 0
زمان تغییرmod_timeصحیح۶۴ = 0
حالتmodeطبیعی۳۲ = 0
خواندنیreadableمنطقی = نادرست
نوشتنیwritableمنطقی = نادرست
اجراپذیرexecutableمنطقی = نادرست

نوع رویداد EventKind

جداشمار نوع رویداد
نامانگلیسیگونهتوضیح
CreatedCreated
ModifiedModified
DeletedDeleted

رویداد Event

ساختار رویداد
نامانگلیسیگونهتوضیح
نوعkindنوع رویداد
مسیرpathرشته = ""

ناظر Watcher

ساختار ناظر
نامانگلیسیگونهتوضیح
ریشهrootرشته = ""
بازگشتیrecursiveمنطقی = درست
اثر انگشتfingerprintsمجموعه ها.نگاشت مرتب
آمادهinitializedمنطقی = نادرست

تابع‌ها

بازکردن Open

تابع بازکردن(path: رشته، mode: رشته): پرونده*
پرونده را برای کار تکه‌تکه باز می‌کند؛ حالت‌ها همان حالت‌های سیستم عامل.بازکردن است. اگر نتواند تهی برمی‌گرداند.
fs-ReadText.salam
واردسازی سیستم پرونده

تابع ریشه:
    سیستم پرونده.نوشتن متن("شعر.txt"، "بنی آدم اعضای یکدیگرند\n")
    سیستم پرونده.افزودن("شعر.txt"، "که در آفرینش ز یک گوهرند\n")
    چاپ سیستم پرونده.خواندن متن("شعر.txt")
    سرچاپ سیستم پرونده.خواندن همه("شعر.txt") == سیستم پرونده.خواندن متن("شعر.txt")
    خط‌ها := سیستم پرونده.خواندن خط‌ها("شعر.txt")
    سرچاپ خط‌ها.طول()، خط‌ها.بگیر(۱)
    سیستم پرونده.نوشتن بایت‌ها("داده.bin"، "ABCDEF")
    سرچاپ سیستم پرونده.خواندن بایت‌ها("داده.bin"، ۳)
    سیستم پرونده.نوشتن اتمی("تنظیمات.txt"، "زبان=فارسی")
    سرچاپ سیستم پرونده.خواندن متن("تنظیمات.txt")
    پ := سیستم پرونده.بازکردن("شعر.txt"، "rb")
    سرچاپ پ.خواندن خط()
    سیستم پرونده.بستن(پ)
پایان
خروجیبنی آدم اعضای یکدیگرند که در آفرینش ز یک گوهرند true 2 که در آفرینش ز یک گوهرند ABC زبان=فارسی بنی آدم اعضای یکدیگرند

بستن Close

تابع بستن(f: پرونده*)
پرونده‌ی باز را می‌بندد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-ReadText.salam

خواندن متن ReadText

تابع خواندن متن(path: رشته): رشته
کل پرونده را به شکل متن می‌خواند؛ اگر پرونده باز نشود خالی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-ReadText.salam

خواندن همه ReadAll

تابع خواندن همه(path: رشته): رشته
کل پرونده را می‌خواند، درست مثل خواندن متن. نتیجه یک رشته است، پس پرونده‌ی دودویی در نخستین بایت صفرش بریده می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-ReadText.salam

خواندن بایت‌ها ReadBytes

تابع خواندن بایت‌ها(path: رشته، n: صحیح): رشته
حداکثر n بایت اول پرونده را می‌خواند، مثلاً سرآیندی برای شناختن قالبش؛ در بایت صفر کوتاه می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-ReadText.salam

خواندن خط‌ها ReadLines

تابع خواندن خط‌ها(path: رشته): وکتور<رشته>
خط‌های پرونده را در یک وکتور برمی‌گرداند، بدون شکست خط و با حذف \r پایانی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-ReadText.salam

نوشتن متن WriteText

تابع نوشتن متن(path: رشته، data: رشته): صحیح
متن را در پرونده می‌نویسد، پرونده را می‌سازد یا محتوای قبلی را جایگزین می‌کند؛ تعداد بایت‌های نوشته‌شده یا -۱ را برمی‌گرداند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-ReadText.salam

نوشتن بایت‌ها WriteBytes

تابع نوشتن بایت‌ها(path: رشته، data: رشته): صحیح
همان نوشتن متن است. داده یک رشته است، پس در نخستین بایت صفر تمام می‌شود و برای محتوای دودویی امن نیست.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-ReadText.salam

افزودن Append

تابع افزودن(path: رشته، data: رشته): صحیح
به انتهای پرونده اضافه می‌کند و اگر نباشد آن را می‌سازد؛ تعداد بایت‌های نوشته‌شده یا -۱ را برمی‌گرداند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-ReadText.salam

نوشتن اتمی AtomicWrite

تابع نوشتن اتمی(path: رشته، data: رشته): صحیح
path.tmp را می‌نویسد و آن را روی پرونده تغییر نام می‌دهد، پس برنامه‌ی قطع‌شده یا نسخه‌ی کامل تازه را باقی می‌گذارد یا قدیمی را، هرگز پرونده‌ی نیمه‌نوشته. ۰ یا -۱ (همراه با ثبت در خطا) برمی‌گرداند. پرونده‌ی تازه مجوزهای پیش‌فرض را می‌گیرد و داده پیش از آن روی دیسک نشانده نمی‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-ReadText.salam

اندازه Size

تابع اندازه(p: رشته): صحیح۶۴
اندازه‌ی پرونده بر حسب بایت؛ اگر نباشد یا پوشه باشد -۱.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-Stat.salam

پسوند Extension

تابع پسوند(p: رشته): رشته
پسوند پرونده با نقطه و همان بزرگی و کوچکی حرف‌ها، مثل .JPG؛ اگر نباشد خالی.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-Stat.salam

نوع مایم MimeType

تابع نوع مایم(p: رشته): رشته
نوع MIME پرونده بر اساس پسوندش، بی‌توجه به بزرگی و کوچکی حرف، برای فرستادن در وب؛ برای پسوند ناشناخته application/octet-stream. پرونده باز نمی‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-Stat.salam

وضعیت Stat

تابع وضعیت(p: رشته): اطلاعات پرونده
همه‌ی اطلاعات پرونده یک‌جا. در یونیکس فرمان stat سیستم را چهار بار اجرا می‌کند، پس از فراخوانی‌های جداگانه سریع‌تر نیست.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-Stat.salam

کپی Copy

تابع کپی(src: رشته، dst: رشته): صحیح
بایت‌های پرونده را رونوشت می‌کند و مقصد را جایگزین می‌کند؛ مجوزها رونوشت نمی‌شوند. ۰ یا -۱.
fs-Copy.salam
واردسازی سیستم پرونده

تابع ریشه:
    سیستم پرونده.نوشتن متن("اصلی.txt"، "سلام")
    سیستم پرونده.کپی("اصلی.txt"، "رونوشت.txt")
    سیستم پرونده.جابجایی("رونوشت.txt"، "جابه‌جا.txt")
    سیستم پرونده.تغییر نام("جابه‌جا.txt"، "نهایی.txt")
    سرچاپ سیستم پرونده.وجود دارد("رونوشت.txt")، سیستم پرونده.وجود دارد("نهایی.txt")، سیستم پرونده.خواندن متن("نهایی.txt")
    سیستم پرونده.حذف("نهایی.txt")
    سرچاپ سیستم پرونده.وجود دارد("نهایی.txt")
پایان
خروجیfalse true سلام false

جابجایی Move

تابع جابجایی(src: رشته، dst: رشته): صحیح
پرونده را با تغییر نام جابه‌جا می‌کند، پس میان دو دیسک شکست (-۱) می‌خورد. پوشه.جابجایی می‌تواند به‌جایش رونوشت بگیرد.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-Copy.salam

تغییر نام Rename

تابع تغییر نام(src: رشته، dst: رشته): صحیح
نام پرونده را عوض می‌کند؛ همان جابجایی است.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-Copy.salam

حذف Delete

تابع حذف(p: رشته): صحیح
پرونده را حذف می‌کند؛ ۰ یا -۱. هر شکستی، کمبود مجوز هم، در خطا به شکل پرونده یافت نشد ثبت می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-Copy.salam

وجود دارد Exists

تابع وجود دارد(p: رشته): منطقی
اگر مسیر وجود داشته باشد، پرونده یا پوشه، درست برمی‌گرداند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-Stat.salam

هش ام‌دی۵ Md5Hex

تابع هش ام‌دی۵(p: رشته): رشته
چکیده‌ی MD5 محتوای پرونده؛ فقط برای مقایسه‌ی سریع، نه امنیت.
fs-Sha256Hex.salam
واردسازی سیستم پرونده

تابع ریشه:
    سیستم پرونده.نوشتن متن("پیام.txt"، "abc")
    سرچاپ سیستم پرونده.هش ام‌دی۵("پیام.txt")
    سرچاپ سیستم پرونده.هش شا۱("پیام.txt")
    سرچاپ سیستم پرونده.هش شا۲۵۶("پیام.txt")
    سرچاپ سیستم پرونده.هش شا۵۱۲("پیام.txt").طول()
پایان
خروجی900150983cd24fb0d6963f7d28e17f72 a9993e364706816aba3e25717850c26c9cd0d89d ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad 128

هش شا۱ Sha1Hex

تابع هش شا۱(p: رشته): رشته
چکیده‌ی SHA-1 محتوای پرونده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-Sha256Hex.salam

هش شا۲۵۶ Sha256Hex

تابع هش شا۲۵۶(p: رشته): رشته
چکیده‌ی SHA-256 محتوای پرونده؛ برای بررسی سالم بودن پرونده‌ی دانلودشده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-Sha256Hex.salam

هش شا۵۱۲ Sha512Hex

تابع هش شا۵۱۲(p: رشته): رشته
چکیده‌ی SHA-512 محتوای پرونده.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-Sha256Hex.salam

وجود دارد Exists

تابع وجود دارد(path: رشته): منطقی
اگر مسیر وجود داشته باشد، پرونده یا پوشه، درست برمی‌گرداند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-Stat.salam

پرونده است IsFile

تابع پرونده است(path: رشته): منطقی

پوشه است IsDir

تابع پوشه است(path: رشته): منطقی
تابع پیوند است(path: رشته): منطقی
تابع پیوند نمادین است(path: رشته): منطقی

اندازه Size

تابع اندازه(path: رشته): صحیح۶۴
اندازه‌ی پرونده بر حسب بایت؛ اگر نباشد یا پوشه باشد -۱.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-Stat.salam

قابل خواندن CanRead

تابع قابل خواندن(path: رشته): منطقی

قابل نوشتن CanWrite

تابع قابل نوشتن(path: رشته): منطقی

قابل اجرا CanExecute

تابع قابل اجرا(path: رشته): منطقی

حالت Mode

تابع حالت(path: رشته): طبیعی۳۲

تنظیم حالت SetMode

تابع تنظیم حالت(path: رشته، mode: طبیعی۳۲): منطقی

خواندنی کردن MakeReadable

تابع خواندنی کردن(path: رشته): منطقی

نوشتنی کردن MakeWritable

تابع نوشتنی کردن(path: رشته): منطقی

اجراپذیر کردن MakeExecutable

تابع اجراپذیر کردن(path: رشته): منطقی

زمان تغییر ModTime

تابع زمان تغییر(path: رشته): صحیح۶۴
زمان آخرین تغییر محتوای پرونده، به ثانیه‌ی یونیکس؛ اگر مسیر نباشد -۱.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-Stat.salam

تنظیم اجراپذیر SetExecutable

تابع تنظیم اجراپذیر(path: رشته، executable: منطقی = درست): منطقی

دریافت Get

تابع دریافت(path: رشته): فراداده پرونده

قالب حالت FormatMode

تابع قالب حالت(mode: طبیعی۳۲): رشته

خواندنی است IsReadable

تابع خواندنی است(path: رشته): منطقی

نوشتنی است IsWritable

تابع نوشتنی است(path: رشته): منطقی

اجراپذیر است IsExecutable

تابع اجراپذیر است(path: رشته): منطقی

نام نوع TypeName

تابع نام نوع(path: رشته): رشته

پنهان است IsHidden

تابع پنهان است(path: رشته): منطقی

زمان تغییر ModTime

تابع زمان تغییر(path: رشته): صحیح۶۴
زمان آخرین تغییر محتوای پرونده، به ثانیه‌ی یونیکس؛ اگر مسیر نباشد -۱.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-Stat.salam

زمان دسترسی AccessedTime

تابع زمان دسترسی(path: رشته): صحیح۶۴
زمان آخرین خواندن پرونده، به ثانیه‌ی یونیکس. بسیاری از سیستم‌ها آن را با تأخیر یا هیچ‌وقت به‌روز نمی‌کنند (noatime)، پس به آن تکیه نکنید.
fs-ModTime.salam
واردسازی سیستم پرونده

تابع ریشه:
    سیستم پرونده.نوشتن متن("گزارش.txt"، "سلام")
    ت := سیستم پرونده.زمان تغییر("گزارش.txt")
    سرچاپ ت > ۰، سیستم پرونده.زمان دسترسی("گزارش.txt") > ۰، سیستم پرونده.زمان ایجاد("گزارش.txt") >= ۰
    سیستم پرونده.تغییر مجوز("گزارش.txt"، 0o644)
    سرچاپ سیستم پرونده.مجوزها("گزارش.txt")
پایان
خروجیtrue true true 644

زمان ایجاد CreatedTime

تابع زمان ایجاد(path: رشته): صحیح۶۴
زمان ایجاد پرونده به ثانیه‌ی یونیکس؛ جایی که سیستم پرونده آن را نگه نمی‌دارد، صفر.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-ModTime.salam

تغییر مجوز Chmod

تابع تغییر مجوز(path: رشته، mode: صحیح): صحیح
مجوزهای پرونده را تغییر می‌دهد؛ مجوز را هشت‌هشتی بدهید، مثل 0o644. در صورت موفقیت ۰ و در صورت شکست -۱. در ویندوز فقط پرچم فقط خواندنی عوض می‌شود.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-ModTime.salam

مجوزها Permissions

تابع مجوزها(path: رشته): صحیح
مجوزهای پرونده، یعنی رقم‌های هشت‌هشتی که مثل عدد ده‌دهی خوانده می‌شوند، مثل 644؛ اگر مسیر نباشد -۱. در ویندوز به‌جایش ۲۹۲ یا ۴۳۸ برمی‌گرداند.

نمونه‌ی این مورد همراه با موارد بالاتر آمده است: fs-ModTime.salam

جدید New

تابع جدید(root: رشته، recursive: منطقی = درست): ناظر

تصویر فوری Snapshot

تابع تصویر فوری(w &: ناظر)

بررسی Poll

تابع بررسی(w &: ناظر): وکتور<رویداد>

بررسی با تاخیر PollSleepMs

تابع بررسی با تاخیر(w &: ناظر، ms: صحیح): وکتور<رویداد>

بازنشانی Reset

تابع بازنشانی(w &: ناظر)

آزادسازی رویدادها FreeEvents

تابع آزادسازی رویدادها(events &: وکتور<رویداد>)

آماده است IsInitialized

تابع آماده است(w &: ناظر): منطقی

ریشه Root

تابع ریشه(w &: ناظر): رشته

آزادسازی Free

تابع آزادسازی(w &: ناظر)