[API Proposal]: Add FileAttributes.None

[meziantou]

Background and motivation

Similar to #79868, but for System.IO.FileAttributes.

One use-case for the 0 value is when enumerating files. 0 allows to not exclude files from enumeration based on their attributes.

new System.IO.EnumerationOptions()
{
    AttributesToSkip = 0,
}

API Proposal

namespace System.IO;

[System.Flags]
public enum FileAttributes
{
    None = 0,

    // Existing values:
    // ReadOnly
    // Hidden
    // ...

API Usage

Directory.EnumerateFiles("folder", "*", new System.IO.EnumerationOptions()
{
    AttributesToSkip = FileAttributes.None,
});

Could also be used in

runtime/src/libraries/System.Private.CoreLib/src/System/IO/Enumeration/FileSystemEnumerator.Unix.cs

Line 132 in 967250c

if (!isSpecialDirectory && _options.AttributesToSkip != 0)

Alternative Designs

No response

Risks

No response

[ghost]

Tagging subscribers to this area: @dotnet/area-system-io
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Background and motivation

Similar to #79868, but for System.IO.FileAttributes.

One use-case for the 0 value is when enumerating files. 0 allows to not exclude files from enumeration based on their attributes.

new System.IO.EnumerationOptions()
{
    AttributesToSkip = 0,
}

API Proposal

namespace System.IO;

[System.Flags]
public enum FileAttributes
{
    None = 0,

    // Existing values:
    // ReadOnly
    // Hidden
    // ...

API Usage

Directory.EnumerateFiles("folder", "*", new System.IO.EnumerationOptions()
{
    AttributesToSkip = FileAttributes.None,
});

Could also be used in

runtime/src/libraries/System.Private.CoreLib/src/System/IO/Enumeration/FileSystemEnumerator.Unix.cs

Line 132 in 967250c

if (!isSpecialDirectory && _options.AttributesToSkip != 0)

Alternative Designs

No response

Risks

No response

Author:	meziantou
Assignees:	-
Labels:	api-suggestion, area-System.IO
Milestone:	-

[Jozkee]

Directory.EnumerateFiles("folder", "*", new System.IO.EnumerationOptions()
{
    AttributesToSkip = FileAttributes.None,
});

Could this skip files without attributes?

[meziantou]

Could this skip files without attributes?

The current implementation skips the check for specific attributes when it's set to 0. I'm not sure we want to change this behavior.

[adamsitnik]

LGTM as proposed, I am going to present it for the API Review Board.

[terrajobst]

Video

• Looks good as proposed
  • Users might be confused by None vs Normal but we believe it's Not A Big Deal™️.

namespace System.IO;

[System.Flags]
public enum FileAttributes
{
    None = 0,
    // Existing members omitted
}