Skip to main content

NetdocParseableFields

tor_netdoc::parse2

Trait NetdocParseableFields 

Source 
pub trait NetdocParseableFields: Sized {
    type Accumulator: Sized + Debug + Send + Sync + 'static;

    // Required methods
    fn is_item_keyword(kw: KeywordRef<'_>) -> bool;
    fn accumulate_item(
        acc: &mut Self::Accumulator,
        item: UnparsedItem<'_>,
    ) -> Result<(), EP>;
    fn finish(
        acc: Self::Accumulator,
        items: &ItemStream<'_>,
    ) -> Result<Self, EP>;
}
Expand description

A collection of fields that can be parsed within a section

None of the items can be structural.

Normally derived.

Required Associated Types§

Source

type Accumulator: Sized + Debug + Send + Sync + 'static

The partially-parsed set of items.

Required Methods§

Source

fn is_item_keyword(kw: KeywordRef<'_>) -> bool

Is this one of the keywords in this struct

Source

fn accumulate_item( acc: &mut Self::Accumulator, item: UnparsedItem<'_>, ) -> Result<(), EP>

Accumulate an item in this struct

§Panics

The caller must have first checked the item’s keyword with is_item_keyword. If this isn’t an item for this structure, may panic.

Source

fn finish(acc: Self::Accumulator, items: &ItemStream<'_>) -> Result<Self, EP>

Finish

Resolves the Accumulator into the output type. Generally, this means throwing an error if expected fields were not present.

items is provided to obtain the parsing options and similar purposes. Its position in the input stream should not be relied on.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types§

Source§

impl<T: NetdocParseableFields> NetdocParseableFields for Arc<T>

Source§

type Accumulator = <T as NetdocParseableFields>::Accumulator

Source§

fn is_item_keyword(kw: KeywordRef<'_>) -> bool

Source§

fn accumulate_item( acc: &mut Self::Accumulator, item: UnparsedItem<'_>, ) -> Result<(), EP>

Source§

fn finish(acc: Self::Accumulator, items: &ItemStream<'_>) -> Result<Self, EP>

Implementors§