Opal 1.0.4

There is a newer version of this package available.
See the version list below for details.
dotnet add package Opal --version 1.0.4                
NuGet\Install-Package Opal -Version 1.0.4                
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.4" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Opal --version 1.0.4                
#r "nuget: Opal, 1.0.4"                
#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.
// Install Opal as a Cake Addin
#addin nuget:?package=Opal&version=1.0.4

// Install Opal as a Cake Tool
#tool nuget:?package=Opal&version=1.0.4                

Opal on Nuget Opal build Last commit MIT

Opal

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

Features

  • Asynchronous and Synchronous requests
  • 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.3

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(TimeSpan.FromDays(100), "some person");

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. 
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.

Version Downloads Last updated
1.7.6 383 1/6/2024
1.7.4 524 10/4/2023
1.7.2 594 7/14/2023
1.7.1 600 6/13/2023
1.6.1 607 6/4/2023
1.6.0 581 5/11/2023
1.5.0 604 5/1/2023
1.4.0 615 4/7/2023
1.3.1 583 4/7/2023
1.3.0 750 12/12/2022
1.2.0 775 11/6/2022
1.1.3 886 7/17/2022
1.1.2 848 6/12/2022
1.1.1 826 6/6/2022
1.1.0 864 6/3/2022
1.0.4 850 5/28/2022
1.0.3 884 5/7/2022
1.0.2 862 5/6/2022
1.0.1 844 5/5/2022
1.0.0 823 5/4/2022