Opal 1.0.1

There is a newer version of this package available.
See the version list below for details.

dotnet add package Opal --version 1.0.1

NuGet\Install-Package Opal -Version 1.0.1

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Opal" Version="1.0.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Opal" Version="1.0.1" />
                    

                            Directory.Packages.props

<PackageReference Include="Opal" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Opal --version 1.0.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Opal, 1.0.1"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package Opal@1.0.1

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Opal&version=1.0.1
                    

                            Install as a Cake Addin

#tool nuget:?package=Opal&version=1.0.1
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Opal

A client library for the Gemini protocol written for .NET 6

Features

Synchronous requests (async coming soon)
Typed Gemtext document handling
Event-based user input
Configurable redirect behavior
Optional client certificate support with creation and persistence
Optional TOFU semantics with persistent certificate caching
No external libraries (only uses what .NET provides)

Usage

Install the Nuget package

Install-Package Opal -Version 1.0.0

Create an instance of a client and make requests

// the default behavior is to automatically follow redirects and to persit 
// local and remote certificates to disk
var client = OpalClient.CreateNew(OpalOptions.Default);

var response = client.SendRequest("gemini.circumlunar.space");

if (response is GemtextResponse gmi)
{
  // the response body may accessed directly...
  using (var reader = new StreamReader(gmi.Body))
    Console.WriteLine(reader.ReadToEnd());
  
  // ... or as a collection of strongly-typed ILine objects
  foreach (var line in gmi.AsDocument())
  {
    if (line is LinkLine link)
      Console.WriteLine($"Found link to {link.Uri}");
     
    Console.WriteLine(line);
  }
}

Subscribe to events in order to control certain protocol features

var client = OpalClient.CreateNew(OpalOptions.Default);

// using the default configuration, this certificate will be saved to the disk and
// sent whenever this host asks for it
client.CertificateRequired += (_, e) =>
  e.Certificate = CertificateHelper.GenerateNew($"cool glasses for {e.Host}", TimeSpan.FromDays(100));

client.InputRequired += 
  (_, e) => 
  {
    Console.Write($"{e.Prompt}: ");
    e.Value = Console.ReadLine();
  };

Product	Compatible and additional computed target framework versions.
.NET	net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net6.0
- No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.