Struct brokaw::types::response::BinaryArticle

pub struct BinaryArticle { /* fields omitted */ }

A binary Netnews article

A BinaryArticle is created by calling try_from with a RawResponse.

For text articles, consider converting this article into a TextArticle.

Implementation Notes

Articles aim to follow RFC 3977 as closely as possible while remaining ergonomic.

1. Response parsing will fail if the header names are not UTF-8
2. The header contents will be lossily converted to UTF-8
3. There are no formatting constraints on the body

Implementations

impl BinaryArticle

pub fn number(&self) -> ArticleNumber

The number of the article relative to the group it was retrieved from

pub fn message_id(&self) -> &str

The message id of the article

pub fn headers(&self) -> &Headers

The headers on the article

pub fn body(&self) -> &[u8]

The raw contents of the body

pub fn lines_len(&self) -> usize

The number of lines in the body

pub fn lines(&self) -> Lines

An iterator over the lines in the body of the article

pub fn unterminated(&self) -> Unterminated

An iterator over the lines of the body without the CRLF terminators

pub fn to_text(&self) -> Result<TextArticle>

Convert the article into a TextArticle

This will return an error if the body is not valid UTF-8

pub fn to_text_lossy(&self) -> TextArticle

Convert the article into a TextArticle including invalid characters.

This function is analogous to calling is String::from_utf8_lossy on every line in the body

Trait Implementations

impl Clone for BinaryArticle

fn clone(&self) -> BinaryArticle

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BinaryArticle

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Display for BinaryArticle

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for BinaryArticle

impl PartialEq<BinaryArticle> for BinaryArticle

fn eq(&self, other: &BinaryArticle) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &BinaryArticle) -> bool

This method tests for !=.

impl StructuralEq for BinaryArticle

impl StructuralPartialEq for BinaryArticle

impl<'_> TryFrom<&'_ RawResponse> for BinaryArticle

type Error = Error

The type returned in the event of a conversion error.

fn try_from(resp: &RawResponse) -> Result<Self>

Convert a raw response into an article

For the specification see RFC 3977 sections:

• response-220-content
• article