Struct dangerous::error::RetryRequirement

pub struct RetryRequirement(_);

An indicator of how many bytes are required to continue processing input.

Although the value allows you to estimate how much more input you need till you can continue processing the input, it is a very granular value and may result in a lot of wasted reprocessing of input if not handled correctly.

Implementations

impl RetryRequirement

pub fn new(value: usize) -> Option<Self>

Create a new RetryRequirement.

If the provided value is 0, this signifies processing can't be retried. If the provided value is greater than 0, this signifies the amount of additional input bytes required to continue processing.

pub fn from_had_and_needed(had: usize, needed: usize) -> Option<Self>

Create a retry requirement from a count of how many bytes we had and how many we needed.

pub fn met_by(self, count: usize) -> bool

Returns true if a provided count meets the requirement.

pub fn continue_after(self) -> usize

An indicator of how many bytes are required to continue processing input, if applicable.

Although the value allows you to estimate how much more input you need till you can continue processing the input, it is a very granular value and may result in a lot of wasted reprocessing of input if not handled correctly.

pub fn continue_after_non_zero(self) -> NonZeroUsize

Returns a NonZeroUsize wrapped variant of continue_after.

Trait Implementations

impl Clone for RetryRequirement

fn clone(&self) -> RetryRequirement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for RetryRequirement

impl Debug for RetryRequirement

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

Formats the value using the given formatter.

impl Display for RetryRequirement

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

Formats the value using the given formatter.

impl Eq for RetryRequirement

impl PartialEq<RetryRequirement> for RetryRequirement

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

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

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

This method tests for !=.

impl StructuralEq for RetryRequirement

impl StructuralPartialEq for RetryRequirement

impl ToRetryRequirement for RetryRequirement

fn to_retry_requirement(&self) -> Option<RetryRequirement>

Returns the requirement, if applicable, to retry processing the Input.