Link.cs

// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

using System.Diagnostics;

namespace OpenTelemetry.Trace;

/// <summary>
/// Link associated with the span.
/// </summary>
public readonly struct Link : IEquatable<Link>
{
    internal readonly ActivityLink ActivityLink;

    /// <summary>
    /// Initializes a new instance of the <see cref="Link"/> struct.
    /// </summary>
    /// <param name="spanContext">Span context of a linked span.</param>
    public Link(in SpanContext spanContext)
        : this(in spanContext, attributes: null)
    {
    }

    /// <summary>
    /// Initializes a new instance of the <see cref="Link"/> struct.
    /// </summary>
    /// <param name="spanContext">Span context of a linked span.</param>
    /// <param name="attributes">Link attributes.</param>
    public Link(in SpanContext spanContext, SpanAttributes? attributes)
    {
        this.ActivityLink = new ActivityLink(spanContext.ActivityContext, attributes?.Attributes);
    }

    /// <summary>
    /// Gets the span context of a linked span.
    /// </summary>
    public SpanContext Context
        => new(this.ActivityLink.Context);

    /// <summary>
    /// Gets the collection of attributes associated with the link.
    /// </summary>
    public IEnumerable<KeyValuePair<string, object?>>? Attributes
        => this.ActivityLink.Tags;

    /// <summary>
    /// Compare two <see cref="Link"/> for equality.
    /// </summary>
    /// <param name="link1">First link to compare.</param>
    /// <param name="link2">Second link to compare.</param>
    public static bool operator ==(Link link1, Link link2)
        => link1.Equals(link2);

    /// <summary>
    /// Compare two <see cref="Link"/> for not equality.
    /// </summary>
    /// <param name="link1">First link to compare.</param>
    /// <param name="link2">Second link to compare.</param>
    public static bool operator !=(Link link1, Link link2)
        => !link1.Equals(link2);

    /// <inheritdoc />
    public override bool Equals(object? obj)
        => obj is Link link && this.ActivityLink.Equals(link.ActivityLink);

    /// <inheritdoc />
    public override int GetHashCode()
        => this.ActivityLink.GetHashCode();

    /// <inheritdoc/>
    public bool Equals(Link other)
        => this.ActivityLink.Equals(other.ActivityLink);
}