NetdocParseable

tor_netdoc::parse2

Trait NetdocParseable

pub trait NetdocParseable: Sized {
    // Required methods
    fn doctype_for_error() -> &'static str;
    fn is_intro_item_keyword(kw: KeywordRef<'_>) -> bool;
    fn from_items(
        input: &mut ItemStream<'_>,
        stop_at: StopAt<impl StopPredicate>,
    ) -> Result<Self, ErrorProblem>;
}

Available on crate feature parse2 only.

Expand description

A document or section that can be parsed

Normally derived.

Required Methods§

fn doctype_for_error() -> &'static str

Document type for errors, normally its intro keyword

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

Is Keyword an intro Item Keyword for this kind of document?

This is used with 1-keyword lookahead, to allow us to push or pop the parsing state into or out of a sub-document.

For signatures sections, this should report every recognised keyword.

fn from_items( input: &mut ItemStream<'_>, stop_at: StopAt<impl StopPredicate>, ) -> Result<Self, ErrorProblem>

Parse the document from a stream of Items

Should stop before reading any keyword matching stop_at. (Except, right at the start.)

Should also stop before reading a 2nd intro keyword, so that successive calls to this function can parse successive sub-documents of this kind.

Otherwise, should continue until EOF.

Must check whether the first item is this document’s is_intro_item_keyword, and error if not.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types§

impl<T: NetdocParseable> NetdocParseable for Arc<T>

fn doctype_for_error() -> &'static str

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

fn from_items( input: &mut ItemStream<'_>, stop_at: StopAt<impl StopPredicate>, ) -> Result<Self, EP>

Implementors§

impl NetdocParseable for tor_netdoc::doc::netstatus::md::RouterStatus

impl NetdocParseable for tor_netdoc::doc::netstatus::plain::RouterStatus

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::doc::netstatus::vote::RouterStatus

Available on crate feature ns-vote only.

impl NetdocParseable for DirAuthKeyCert

Available on crate feature plain-consensus only.

impl NetdocParseable for DirAuthKeyCertSignatures

Available on crate feature plain-consensus only.

impl NetdocParseable for DirAuthKeyCertSigned

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::parse2::poc::netstatus::cons::NddAuthorityEntry

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::parse2::poc::netstatus::cons::NddAuthoritySection

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::parse2::poc::netstatus::cons::NddDirectoryFooter

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::parse2::poc::netstatus::cons::NetworkStatusSignatures

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::parse2::poc::netstatus::md::NddAuthorityEntry

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::parse2::poc::netstatus::md::NddAuthoritySection

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::parse2::poc::netstatus::md::NddDirectoryFooter

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::parse2::poc::netstatus::md::NetworkStatusSignatures

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::parse2::poc::netstatus::NetworkStatusMd

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::parse2::poc::netstatus::NetworkStatusNs

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::parse2::poc::netstatus::NetworkStatusSignedMd

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::parse2::poc::netstatus::NetworkStatusSignedNs

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::parse2::poc::netstatus::NetworkStatusSignedVote

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::parse2::poc::netstatus::NetworkStatusVote

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::parse2::poc::netstatus::vote::NddAuthorityEntry

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::parse2::poc::netstatus::vote::NddAuthoritySection

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::parse2::poc::netstatus::vote::NddDirectoryFooter

Available on crate feature plain-consensus only.

impl NetdocParseable for tor_netdoc::parse2::poc::netstatus::vote::NetworkStatusSignatures

Available on crate feature plain-consensus only.