SuccessfulValue Class

Definition

Namespace

Cuemon

Assemblies

Cuemon.Kernel.dll

Source

src/Cuemon.Kernel/SuccessfulValue.cs

Provides a way to indicate a successful operation. This class cannot be inherited.

public sealed class SuccessfulValue : ConditionalValue

Inheritance

object

ConditionalValue

SuccessfulValue

Inherited Members

ConditionalValue.Succeeded

ConditionalValue.Failure

Examples

The following example demonstrates how to use SuccessfulValue to represent a void operation that completed successfully, enabling consistent conditional-return patterns.

using System;
using Cuemon;

namespace Contoso.Startup;

public sealed class SuccessfulValueExample
{
    public static void Run()
    {
        ConditionalValue outcome = WarmUpCache(dependenciesReady: true);

        Console.WriteLine($"Succeeded: {outcome.Succeeded}");
        Console.WriteLine($"Failure is null: {outcome.Failure is null}");
    }

    private static ConditionalValue WarmUpCache(bool dependenciesReady)
    {
        if (!dependenciesReady)
        {
            return new UnsuccessfulValue(new InvalidOperationException("Dependencies are missing."));
        }

        return new SuccessfulValue();
    }
}

Constructors

Name	Description
SuccessfulValue()	Initializes a new instance of the SuccessfulValue class.

See Also

ConditionalValue