Struct switchboard_utils::protos::oracle_job::BoundTask

pub struct BoundTask {
    pub lower_bound: Option<OracleJob>,
    pub lower_bound_value: Option<String>,
    pub upper_bound: Option<OracleJob>,
    pub upper_bound_value: Option<String>,
    pub on_exceeds_upper_bound: Option<OracleJob>,
    pub on_exceeds_upper_bound_value: Option<String>,
    pub on_exceeds_lower_bound: Option<OracleJob>,
    pub on_exceeds_lower_bound_value: Option<String>,
}

Bound the running result to an upper/lower bound. This is typically the last task in an OracleJob.

Input: The current running numerical result.

Returns: The running result bounded to an upper or lower bound if it exceeds a given threshold.

Example: Bound the running result to a value between 0.90 and 1.10

{ "boundTask": { "lowerBoundValue": "0.90","onExceedsLowerBoundValue": "0.90","upperBoundValue": "1.10","onExceedsUpperBoundValue": "1.10" } }

Fields

lower_bound: Option<OracleJob>

/ The OracleJob to execute for the lower bound value.

lower_bound_value: Option<String>

/ The value to use for the lower bound. Can be set to a ${CACHE_KEY}.

upper_bound: Option<OracleJob>

/ The OracleJob to execute for the upper bound value.

upper_bound_value: Option<String>

/ The value to use for the upper bound. Can be set to a ${CACHE_KEY}.

on_exceeds_upper_bound: Option<OracleJob>

/ The OracleJob to execute if the upper bound is exceeded.

on_exceeds_upper_bound_value: Option<String>

/ The value to use if the upper bound is exceeded. Can be set to a ${CACHE_KEY}.

on_exceeds_lower_bound: Option<OracleJob>

/ The OracleJob to execute if the lower bound is exceeded.

on_exceeds_lower_bound_value: Option<String>

/ The value to use if the lower bound is exceeded. Can be set to a ${CACHE_KEY}.

Implementations

impl BoundTask

pub fn lower_bound_value(&self) -> &str

Returns the value of lower_bound_value, or the default value if lower_bound_value is unset.

pub fn upper_bound_value(&self) -> &str

Returns the value of upper_bound_value, or the default value if upper_bound_value is unset.

pub fn on_exceeds_upper_bound_value(&self) -> &str

Returns the value of on_exceeds_upper_bound_value, or the default value if on_exceeds_upper_bound_value is unset.

pub fn on_exceeds_lower_bound_value(&self) -> &str

Returns the value of on_exceeds_lower_bound_value, or the default value if on_exceeds_lower_bound_value is unset.

Trait Implementations

impl Clone for BoundTask

fn clone(&self) -> BoundTask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoundTask

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

Formats the value using the given formatter.

impl Default for BoundTask

fn default() -> Self

Returns the “default value” for a type.

impl Message for BoundTask

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8> where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8> where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for BoundTask

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

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

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

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

impl StructuralPartialEq for BoundTask