[][src]Crate brokaw

🗞 Brokaw is an Usenet/NNTP client library

APIs

Brokaw provides two primary APIs:

  1. The NntpClient provides a higher-level that provides a a config based builder and automatic deserialization of responses into different types.
  2. The NntpConnection provides a lower-level abstraction that only provides validation that messages adhere to NNTP's wire format.

Please check out the git repository examples.

Modules

client

The high-level client and configuration API

error

Error and Result types returned by the Brokaw

raw

Low level connection/stream APIs

types

Typed commands, responses, and response codes

Structs

ClientConfig

Configuration for an NntpClient

ConnectionConfig

A builder for NntpConnection

NntpClient

A client that returns typed responses and provides state management

NntpConnection

A raw connection to an NNTP Server

Enums

Compression

A type of compression enabled on the server