HVO.NinaClient 1.0.1

HVO.SDK

Shared .NET libraries for observatory software, astronomy, weather, power, imaging, and hardware integration.

Packages

Installation

dotnet add package HVO.Core

Replace HVO.Core with the package needed by your application. Package-specific platform notes are included in each NuGet package readme.

Quick Start

Result<T> — Railway-oriented error handling

using HVO.Core.Results;

public Result<Customer> GetCustomer(int id)
{
    try
    {
        var customer = _repository.Find(id);
        return customer != null
            ? Result<Customer>.Success(customer)
            : Result<Customer>.Failure(new NotFoundException($"Customer {id} not found"));
    }
    catch (Exception ex)
    {
        return ex; // Implicit conversion to failure
    }
}

// Usage
var result = GetCustomer(42);
var output = result.Match(
    success: c => $"Found: {c.Name}",
    failure: ex => $"Error: {ex.Message}");

Result<T, TEnum> — Typed error codes

using HVO.Core.Results;

public enum OrderError { NotFound, InvalidAmount, Unauthorized }

public Result<Order, OrderError> ValidateOrder(OrderRequest request)
{
    if (request.Amount <= 0)
        return OrderError.InvalidAmount; // Implicit conversion

    return Result<Order, OrderError>.Success(new Order(request));
}

Option<T> — Safe optional values

using HVO.Core.Options;

public Option<string> GetSetting(string key)
{
    return _config.TryGetValue(key, out var value)
        ? new Option<string>(value)
        : Option<string>.None();
}

// Usage
var setting = GetSetting("timeout");
var value = setting.GetValueOrDefault("30"); // Returns "30" if None

OneOf<T1, T2> — Discriminated unions

using HVO.Core.OneOf;

OneOf<int, string> result = 42;

var output = result.Match(
    i => $"Got integer: {i}",
    s => $"Got string: {s}");
// output: "Got integer: 42"

Guard & Ensure — Input validation and state assertions

using HVO.Core.Utilities;

// Guard: validates input parameters (throws ArgumentException)
public void Process(string name, int count)
{
    Guard.AgainstNullOrWhiteSpace(name);
    Guard.AgainstNegativeOrZero(count, 0);
}

// Ensure: asserts internal state (throws InvalidOperationException)
public void Execute()
{
    Ensure.That(_isInitialized, "Service must be initialized");
    Ensure.NotNull(_connection, "Connection not established");
}

Extensions

using HVO.Core.Extensions;

// String extensions
"hello world".ToTitleCase();           // "Hello World"
"Hello World Test".RemoveWhitespace(); // "HelloWorldTest"
"Second".ToEnum<MyEnum>();             // MyEnum.Second

// Collection extensions
new[] { 1, 2, 3 }.ForEach(x => Console.Write(x));
items.DistinctBy(x => x.Id);
items.Shuffle();

// Enum extensions
MyEnum.Value.GetDescription(); // Returns [Description] attribute value

Compatibility

HVO.Core targets .NET Standard 2.0 for maximum compatibility:

• .NET Framework 4.8.1+
• .NET 8+
• .NET 10+
• Mono, Xamarin, Unity

Building

dotnet build
dotnet test

Documentation

Contributing

See CONTRIBUTING.md for PR workflow, coding standards, and how to run tests locally.

License

MIT