-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
41def7c
commit 555a791
Showing
3 changed files
with
47 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
41 changes: 41 additions & 0 deletions
41
...raries/System.Private.CoreLib/src/System/Diagnostics/CodeAnalysis/UnscopedRefAttribute.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
// Licensed to the .NET Foundation under one or more agreements. | ||
// The .NET Foundation licenses this file to you under the MIT license. | ||
|
||
namespace System.Diagnostics.CodeAnalysis | ||
{ | ||
/// <summary> | ||
/// Used to indicate a byref escapes and is not scoped. | ||
/// </summary> | ||
/// <remarks> | ||
/// <para> | ||
/// There are several cases where the C# compiler treats a <see langword="ref"/> as implicitly | ||
/// <see langword="scoped"/> - where the compiler does not allow the <see langword="ref"/> to escape the method. | ||
/// </para> | ||
/// <para> | ||
/// For example: | ||
/// <list type="number"> | ||
/// <item><see langword="this"/> for <see langword="struct"/> instance methods.</item> | ||
/// <item><see langword="ref"/> parameters that refer to <see langword="ref"/> <see langword="struct"/> types.</item> | ||
/// <item><see langword="out"/> parameters.</item> | ||
/// </list> | ||
/// </para> | ||
/// <para> | ||
/// This attribute is used in those instances where the <see langword="ref"/> should be allowed to escape. | ||
/// </para> | ||
/// <para> | ||
/// Applying this attribute, in any form, has impact on consumers of the applicable API. It is necessary for | ||
/// API authors to understand the lifetime implications of applying this attribute and how it may impact their users. | ||
/// </para> | ||
/// </remarks> | ||
[AttributeUsageAttribute( | ||
AttributeTargets.Method | AttributeTargets.Property | AttributeTargets.Parameter, | ||
AllowMultiple = false, | ||
Inherited = false)] | ||
public sealed class UnscopedRefAttribute : Attribute | ||
{ | ||
/// <summary> | ||
/// Initializes a new instance of the <see cref="UnscopedRefAttribute"/> class. | ||
/// </summary> | ||
public UnscopedRefAttribute() { } | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters