sirh3e/Rust

namespace Sirh3e.Rust.Option;

public partial struct Option<TSome>
{
    /// <summary>
    /// Returns the contained Some value, consuming the self value.
    /// Because this function may panic, its use is generally discouraged. Instead, prefer to use pattern matching and handle the None case explicitly, or call unwrap_or, unwrap_or_else, or unwrap_or_default
    /// </summary>
    /// <returns></returns>
    public TSome Unwrap()
        => Unwrap($"called `Option.Unwrap()` on a `None` value of type `{typeof(TSome)}`");

    /// <summary>
    /// Returns the contained Some value, consuming the self value with custom error message.
    /// Because this function may panic, its use is generally discouraged. Instead, prefer to use pattern matching and handle the None case explicitly, or call unwrap_or, unwrap_or_else, or unwrap_or_default
    /// </summary>
    /// <param name="error"></param>
    /// <returns></returns>
    /// <exception cref="ArgumentNullException">Throws only if error is null or empty</exception>
    public TSome Unwrap(string error)
    {
        if ( string.IsNullOrEmpty(error) )
        {
            throw new ArgumentNullException(nameof(error));
        }

        return Unwrap(() => error);
    }

    /// <summary>
    /// Returns the contained Some value, consuming the self value with custom error message.
    /// Because this function may panic, its use is generally discouraged. Instead, prefer to use pattern matching and handle the None case explicitly, or call unwrap_or, unwrap_or_else, or unwrap_or_default
    /// </summary>
    /// <param name="error"></param>
    /// <returns></returns>
    public TSome Unwrap(Func<string> error)
        => Match(
                 some => some,
                 () => throw new PanicException((_ = error ?? throw new ArgumentNullException(nameof(error)))())
                );
}