Enum TokenResult

pub enum TokenResult {
    Pass,
    Blocked(BlockError),
    Wait(u64),
}

Variants

Pass

Blocked(BlockError)

Wait(u64)

Implementations

impl TokenResult

pub fn new_pass() -> Self

pub fn new_should_wait(nanos_to_wait: u64) -> Self

pub fn new_blocked(block_type: BlockType) -> Self

pub fn new_blocked_with_msg(block_type: BlockType, block_msg: String) -> Self

pub fn new_blocked_with_cause( block_type: BlockType, block_msg: String, rule: Arc<dyn SentinelRule>, snapshot_value: Arc<Snapshot>, ) -> Self

pub fn reset_to_pass(&mut self)

pub fn reset_to_blocked(&mut self, block_type: BlockType)

pub fn reset_to_blocked_with_msg( &mut self, block_type: BlockType, block_msg: String, )

pub fn reset_to_blocked_with_cause( &mut self, block_type: BlockType, block_msg: String, rule: Arc<dyn SentinelRule>, snapshot_value: Arc<Snapshot>, )

pub fn is_pass(&self) -> bool

pub fn is_blocked(&self) -> bool

pub fn is_wait(&self) -> bool

pub fn block_err(&self) -> Option<BlockError>

pub fn nanos_to_wait(&self) -> u64

Trait Implementations

impl Clone for TokenResult

fn clone(&self) -> TokenResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenResult

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

Formats the value using the given formatter.

impl Default for TokenResult

fn default() -> Self

Returns the “default value” for a type.

impl Display for TokenResult

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

Formats the value using the given formatter.

impl PartialEq for TokenResult

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TokenResult