std::filesystem::permissions

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

ファイルシステムライブラリ

クラス
filesystem::path filesystem::filesystem_error filesystem::directory_entry filesystem::directory_iterator filesystem::recursive_directory_iterator    filesystem::file_status filesystem::space_info	filesystem::file_type filesystem::file_time_type filesystem::perms filesystem::perm_options filesystem::copy_options filesystem::directory_options
関数
filesystem::absolute filesystem::canonicalfilesystem::weakly_canonical filesystem::relativefilesystem::proximate filesystem::copy filesystem::copy_file filesystem::copy_symlink filesystem::create_directory filesystem::create_directories filesystem::create_hard_link filesystem::create_symlink filesystem::create_directory_symlink filesystem::current_path filesystem::temp_directory_path	filesystem::exists filesystem::equivalent filesystem::file_size filesystem::hard_link_count filesystem::last_write_time filesystem::permissions filesystem::read_symlink filesystem::remove filesystem::remove_all filesystem::rename filesystem::resize_file filesystem::space filesystem::status filesystem::symlink_status
ファイル種別
filesystem::is_block_file filesystem::is_character_file filesystem::is_directory filesystem::is_empty filesystem::status_known	filesystem::is_fifo filesystem::is_other filesystem::is_regular_file filesystem::is_socket filesystem::is_symlink

 

ヘッダー <filesystem> で定義
void permissions( const std::filesystem::path& p,                   std::filesystem::perms prms,                   std::filesystem::perm_options opts = perm_options::replace );	(1)	(C++17以降)
void permissions( const std::filesystem::path& p,                   std::filesystem::perms prms,                   std::error_code& ec ) noexcept;	(2)	(C++17以降)
void permissions( const std::filesystem::path& p,                   std::filesystem::perms prms,                   std::filesystem::perm_options opts,                   std::error_code& ec );	(3)	(C++17以降)

p が解決するファイルへのアクセス権限を変更します。これは POSIX の fchmodat のような動作をします。シンボリックリンクは、opts で perm_options::nofollow が設定されていない限り、たどられます。

2番目のオーバーロードは、opts が perm_options::replace に設定されて呼び出されたかのように動作します。

効果は prms および opts の値によって、以下のように決まります。

• もし opts が perm_options::replace の場合、ファイルのパーミッションは prms & std::filesystem::perms::mask に正確に設定されます（つまり、prms の有効なビットがすべて適用されます）。
• もし opts が perm_options::add の場合、ファイルのパーミッションは status(p).permissions() | (prms & perms::mask) に正確に設定されます（つまり、prms でセットされていて、ファイルの現在のパーミッションにセットされていない有効なビットは、ファイルのパーミッションに追加されます）。
• もし opts が perm_options::remove の場合、ファイルのパーミッションは status(p).permissions() & ~(prms & perms::mask) に正確に設定されます（つまり、prms でクリアされていて、ファイルの現在のパーミッションでセットされている有効なビットは、ファイルのパーミッションでクリアされます）。

opts は、replace、add、または remove のいずれか一つのみがセットされている必要があります。

例外を投げないオーバーロードは、エラー時に特別なアクションを取りません。

Parameters

p	-	検査するパス
prms	-	設定、追加、または削除するパーミッション
opts	-	この関数によって実行されるアクションを制御するオプション
エラーコード	-	例外を投げないオーバーロードでのエラー報告のための出力パラメータ

Return value

(なし)

Exceptions

noexcept とマークされていないオーバーロードは、メモリ割り当てが失敗した場合に std::bad_alloc をスローする可能性があります。

1) 基盤となるOS APIエラーが発生した場合、最初のパス引数としてp、エラーコード引数としてOSのエラーコードとともに構築されたstd::filesystem::filesystem_error を投げます。

2,3) OS API の呼び出しが失敗した場合、std::error_code& パラメーターに OS API のエラーコードが設定され、エラーが発生しなかった場合は ec.clear() が実行されます。

Notes

権限は必ずしもビットとして実装されるとは限りませんが、概念的にはそのように扱われます。

一部の権限ビットは一部のシステムで無視される場合があり、一部のビットを変更すると他のビットも自動的に変更される場合があります（例: 所有者/グループ/その他 の区別がないプラットフォームでは、3つの書き込みビットのいずれかを設定すると、3つすべてが設定されます）。

Example

このコードを実行

#include <filesystem>
#include <fstream>
#include <iostream>
 
void demo_perms(std::filesystem::perms p)
{
    using std::filesystem::perms;
    auto show = [=](char op, perms perm)
    {
        std::cout << (perms::none == (perm & p) ? '-' : op);
    };
    show('r', perms::owner_read);
    show('w', perms::owner_write);
    show('x', perms::owner_exec);
    show('r', perms::group_read);
    show('w', perms::group_write);
    show('x', perms::group_exec);
    show('r', perms::others_read);
    show('w', perms::others_write);
    show('x', perms::others_exec);
    std::cout << '\n';
}
 
int main()
{
    std::ofstream("test.txt"); // create file
 
    std::cout << "Created file with permissions: ";
    demo_perms(std::filesystem::status("test.txt").permissions());
 
    std::filesystem::permissions(
        "test.txt",
        std::filesystem::perms::owner_all | std::filesystem::perms::group_all,
        std::filesystem::perm_options::add
    );
 
    std::cout << "After adding u+rwx and g+rwx:  ";
    demo_perms(std::filesystem::status("test.txt").permissions());
 
    std::filesystem::remove("test.txt");
}

実行結果の例

Created file with permissions: rw-r--r--
After adding u+rwx and g+wrx:  rwxrwxr--

See also

perms (C++17)	ファイルシステムのパーミッションを識別する (列挙型)
statussymlink_status (C++17)(C++17)	ファイルの属性を決定する シンボリックリンクのターゲットを確認してファイルの属性を決定する (関数)