Skip to main content

Article

Struct Article 

Source
pub struct Article<'a> {
    pub message_id: MessageId<'a>,
    pub article_number: Option<u64>,
    pub headers: Option<Headers<'a>>,
    pub body: Option<&'a [u8]>,
}
Expand description

Parsed NNTP article response (zero-copy)

Different response codes populate different fields:

  • 220 ARTICLE: headers + body
  • 221 HEAD: headers only
  • 222 BODY: body only
  • 223 STAT: neither (just metadata)

Fields§

§message_id: MessageId<'a>§article_number: Option<u64>§headers: Option<Headers<'a>>§body: Option<&'a [u8]>

Implementations§

Source§

impl<'a> Article<'a>

Source

pub fn parse(buf: &'a [u8], validate_yenc: bool) -> Result<Self, ParseError>

Parse NNTP article response with optional yEnc validation

§Arguments
  • buf - Complete response bytes from the session response reader.
  • validate_yenc - Whether to validate yEnc structure/checksums
§Errors

Returns ParseError when the NNTP response status line, message metadata, headers, body structure, or optional yEnc validation fails.

Source

pub fn decode(&self) -> Option<Vec<u8>>

Decode yEnc-encoded body to raw bytes

This method allocates a new Vec<u8> for each call. For hot paths where articles are frequently decoded, prefer Article::decode_into to reuse a caller-provided buffer and avoid per-call allocations.

§Returns

Decoded bytes, or None if body is not yEnc-encoded

Source

pub fn decode_into(&self, output: &mut Vec<u8>) -> bool

Decode yEnc-encoded body into the provided buffer

This method reuses the capacity of output and performs no allocations if the buffer is already large enough, making it suitable for hot paths.

§Behavior
  • Returns false if:
    • The article has no body, or
    • The body is not yEnc-encoded (does not start with =ybegin)
  • Returns true and writes the decoded bytes into output otherwise.

On success, output is cleared before writing the decoded bytes.

Trait Implementations§

Source§

impl<'a> Clone for Article<'a>

Source§

fn clone(&self) -> Article<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for Article<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Eq for Article<'a>

Source§

impl<'a> PartialEq for Article<'a>

Source§

fn eq(&self, other: &Article<'a>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for Article<'a>

Source§

impl<'a> TryFrom<&'a [u8]> for Article<'a>

Source§

fn try_from(buf: &'a [u8]) -> Result<Self, Self::Error>

Parse article with yEnc validation enabled by default Use Article::parse(buf, false) to disable validation

Source§

type Error = ParseError

The type returned in the event of a conversion error.

Auto Trait Implementations§

§

impl<'a> Freeze for Article<'a>

§

impl<'a> RefUnwindSafe for Article<'a>

§

impl<'a> Send for Article<'a>

§

impl<'a> Sync for Article<'a>

§

impl<'a> Unpin for Article<'a>

§

impl<'a> UnsafeUnpin for Article<'a>

§

impl<'a> UnwindSafe for Article<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scope for T

Source§

fn with<F, R>(self, f: F) -> R
where Self: Sized, F: FnOnce(Self) -> R,

Scoped with ownership.
Source§

fn with_ref<F, R>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Scoped with reference.
Source§

fn with_mut<F, R>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Scoped with mutable reference.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> Value for T
where T: Send + Sync + 'static,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more