ClearScript/ClearScript/ImmutableValueAttribute.cs at master · r2d2m/ClearScript · GitHub

34 lines (30 loc) · 1.28 KB

// Licensed under the MIT license.

using System;

namespace Microsoft.ClearScript

{

/// <summary>

/// Specifies that instances of the target struct are immutable.

/// </summary>

/// <remarks>

/// When this attribute is applied to a struct, ClearScript exposes the same object reference

/// for all instances of the struct that satisfy equality comparison, giving script code the

/// ability to use native equality operators to compare the exposed objects. This behavior is

/// also enabled automatically for all enums, <c>readonly</c> structs, numeric types,

/// <c><see cref="DateTime"/></c>, <c><see cref="DateTimeOffset"/></c>,

/// <c><see cref="TimeSpan"/></c>, and <c><see cref="Guid"></see></c>.

/// </remarks>

[AttributeUsage(AttributeTargets.Struct)]

public sealed class ImmutableValueAttribute : Attribute

{

// ReSharper disable EmptyConstructor

/// <summary>

/// Initializes a new <c><see cref="ImmutableValueAttribute"/></c> instance.

/// </summary>

public ImmutableValueAttribute()

{

// the help file builder (SHFB) insists on an empty constructor here

}

// ReSharper restore EmptyConstructor

}

Expand file tree