Enum PollResult 

pub enum PollResult {
    Success {
        order: Option<UnsignedOrder>,
        signature: Option<String>,
    },
    TryNextBlock,
    TryOnBlock {
        block_number: u64,
    },
    TryAtEpoch {
        epoch: u64,
    },
    UnexpectedError {
        message: String,
    },
    DontTryAgain {
        reason: String,
    },
}

Result returned when polling a conditional order for tradability.

On Success, contains the on-chain order struct and the pre-signature bytes ready for submission to the orderbook.

Variants

Success

The order is valid and can be submitted now.

When returned by a full signing poll, order and signature are set to the resolved GPv2Order.Data struct and the ABI-encoded signature. When returned by an offline validity check (e.g. TwapOrder::poll_validate), both fields are None.

Fields

order: Option<UnsignedOrder>

The resolved order ready for submission (None for offline checks).

signature: Option<String>

Hex-encoded signature bytes, 0x-prefixed (None for offline checks).

TryNextBlock

Retry on the next block.

TryOnBlock

Retry once the given block number is reached.

Fields

block_number: u64

Target block number.

TryAtEpoch

Retry once the given Unix timestamp is reached.

Fields

epoch: u64

Target Unix timestamp in seconds.

UnexpectedError

An unexpected error occurred.

Fields

message: String

Human-readable error description.

DontTryAgain

This order should never be polled again.

Fields

reason: String

Reason the order is permanently inactive.

Implementations

impl PollResult

pub const fn is_success(&self) -> bool

Returns true if the order is ready to be submitted.

Returns

true for the Success variant, false for all others.

pub const fn is_retryable(&self) -> bool

Returns true if polling should be retried in a future block or epoch.

Returns

true for TryNextBlock, TryOnBlock, or TryAtEpoch; false otherwise.

pub const fn is_terminal(&self) -> bool

Returns true if this order should never be polled again.

Returns

true for the DontTryAgain variant, false otherwise.

pub const fn is_try_next_block(&self) -> bool

Returns true if polling should retry on the very next block.

Returns

true for the TryNextBlock variant, false otherwise.

pub const fn is_try_on_block(&self) -> bool

Returns true if polling should retry once a specific block is reached.

Returns

true for the TryOnBlock variant, false otherwise.

pub const fn is_try_at_epoch(&self) -> bool

Returns true if polling should retry once a specific Unix epoch is reached.

Returns

true for the TryAtEpoch variant, false otherwise.

pub const fn is_unexpected_error(&self) -> bool

Returns true if an unexpected error occurred during polling.

Returns

true for the UnexpectedError variant, false otherwise.

pub const fn is_dont_try_again(&self) -> bool

Returns true if this order should never be polled again (terminal failure).

Returns

true for the DontTryAgain variant, false otherwise.

pub const fn get_block_number(&self) -> Option<u64>

Extract the target block number from a TryOnBlock variant.

Returns None for all other variants.

use cow_composable::PollResult;

let r = PollResult::TryOnBlock { block_number: 12_345_678 };
assert_eq!(r.get_block_number(), Some(12_345_678));
assert_eq!(PollResult::TryNextBlock.get_block_number(), None);

pub const fn get_epoch(&self) -> Option<u64>

Extract the target Unix epoch from a TryAtEpoch variant.

Returns None for all other variants.

use cow_composable::PollResult;

let r = PollResult::TryAtEpoch { epoch: 1_700_000_000 };
assert_eq!(r.get_epoch(), Some(1_700_000_000));
assert_eq!(PollResult::TryNextBlock.get_epoch(), None);

pub const fn order_ref(&self) -> Option<&UnsignedOrder>

Extract the resolved UnsignedOrder from a PollResult::Success variant, if present.

Returns None for all other variants, or when order is None inside Success (e.g. an offline validity check result).

pub const fn as_error_message(&self) -> Option<&str>

Extract the error message from an UnexpectedError or DontTryAgain variant.

Returns None for all other variants.

Trait Implementations

impl Clone for PollResult

fn clone(&self) -> PollResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PollResult

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

Formats the value using the given formatter.

impl Display for PollResult

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

Formats the value using the given formatter.