Struct sequoia_openpgp::cert::CertValidator

pub struct CertValidator(_);

Used to help validate that a packet sequence is a valid Cert.

Methods

impl CertValidator

pub fn new() -> Self

Instantiates a new CertValidator.

pub fn is_cert(&self) -> bool

Returns whether the packet sequence is a valid Cert.

Note: a CertValidator will only return this after CertValidator::finish has been called.

pub fn is_cert_prefix(&self) -> bool

Returns whether the packet sequence forms a valid Cert prefix.

Note: a CertValidator will only return this before CertValidator::finish has been called.

pub fn is_err(&self) -> bool

Returns whether the packet sequence is definitely not a valid Cert.

pub fn push_token(&mut self, token: Token)

Add the token token to the token stream.

pub fn push(&mut self, tag: Tag)

Add a packet of type tag to the token stream.

pub fn finish(&mut self)

Note that the entire message has been seen.

This function may only be called once.

Once called, this function will no longer return CertValidity::CertPrefix.

pub fn check(&self) -> CertValidity

Returns whether the token stream corresponds to a valid Cert.

This returns a tri-state: if the packet sequence is a valid Cert, it returns CertValidity::Cert, if the packet sequence is invalid, then it returns CertValidity::Error. If the packet sequence that has been processed so far is a valid prefix, then it returns CertValidity::CertPrefix.

Note: if CertValidator::finish() hasn't been called, then this function will only ever return either CertValidity::CertPrefix or CertValidity::Error. Once CertValidity::finish() has been called, then it will only return either CertValidity::Cert or CertValidity::Error.

Trait Implementations

impl Debug for CertValidator

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

Formats the value using the given formatter.

impl Default for CertValidator

fn default() -> Self

Returns the "default value" for a type.