brokaw 0.2.0

📰 An NNTP client liberary. More at 11! 📰
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

#![deny(
    missing_copy_implementations,
    missing_debug_implementations,
    missing_docs,
    rust_2018_idioms,
    unconditional_recursion
)]

//! 🗞 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](https://github.com/sgg/brokaw) examples.

#[cfg(doctest)]
doc_comment::doctest!("../README.md");

/// The high-level client and configuration API
pub mod client;

/// Error and Result types returned by the Brokaw
pub mod error;

/// Low level connection/stream APIs
///
/// These deal with raw NNTP connections and byte responses.
/// Consider using the higher level [`client`] APIs unless you have special requirements
pub mod raw;

/// Typed commands, responses, and response codes
pub mod types;

#[doc(inline)]
pub use client::{ClientConfig, NntpClient};
#[doc(inline)]
pub use raw::connection::{ConnectionConfig, NntpConnection};
#[doc(inline)]
pub use raw::Compression;