Enum yata::core::Action

source ·
pub enum Action {
    Buy(u8),
    None,
    Sell(u8),
}
Expand description

Action is basic type of Indicator’s signals

It may be positive (means Buy some amount). It may be negative (means Sell some amount). Or there may be no signal at all.

You can convert Action to analog i8 value using analog() method, where:

  • 1 means buy;
  • -1 means sell;
  • 0 means no signal.

You can convert Action to digital Option<f64> value using ratio() method with internal value in range [-1.0; 1.0], where:

  • negative value means sell some portion;
  • positive value means buy some potion;
  • zero value means there is no distinct decision;
  • None means no signal.

Variants§

§

Buy(u8)

Buy signal

§

None

No signal

§

Sell(u8)

Sell signal

Implementations§

source§

impl Action

source

pub const BUY_ALL: Self = _

Shortcut for Buy All signal

source

pub const SELL_ALL: Self = _

Shortcut for Sell All signal

source

pub fn from_analog(value: i8) -> Self

Create instance from analog signal (which can be only -1, 0 or 1)

Any positive number converts to BUY_ALL

Any negative number converts to SELL_ALL

Zero converts to None

source

pub fn ratio(self) -> Option<ValueType>

Converts value with the interval [-1.0; 1.0]

source

pub fn analog(self) -> i8

Returns a sign (1 or -1) of internal value if value exists and not zero.

Otherwise returns 0.

source

pub fn sign(self) -> Option<i8>

Returns a sign of internal value if value exists

Otherwise returns None

source

pub const fn value(self) -> Option<u8>

Return an internal representation of the value if signal exists or None if it doesn’t.

source

pub const fn is_none(self) -> bool

Checks if there is no signal

source

pub const fn is_some(self) -> bool

Checks if there is signal

Trait Implementations§

source§

impl Clone for Action

source§

fn clone(&self) -> Action

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Action

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Action

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<'de> Deserialize<'de> for Action

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for Action

source§

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

Formats the value using the given formatter. Read more
source§

impl<T: Into<Self> + Copy> From<&T> for Action

source§

fn from(value: &T) -> Self

Converts to this type from the input type.
source§

impl From<Action> for Option<ValueType>

source§

fn from(value: Action) -> Self

Converts to this type from the input type.
source§

impl From<Action> for Option<i8>

source§

fn from(value: Action) -> Self

Converts to this type from the input type.
source§

impl From<Action> for i8

source§

fn from(value: Action) -> Self

Converts to this type from the input type.
source§

impl From<Option<f32>> for Action

source§

fn from(value: Option<f32>) -> Self

Converts to this type from the input type.
source§

impl From<Option<f64>> for Action

source§

fn from(value: Option<f64>) -> Self

Converts to this type from the input type.
source§

impl From<Option<i8>> for Action

source§

fn from(value: Option<i8>) -> Self

Converts to this type from the input type.
source§

impl From<bool> for Action

source§

fn from(value: bool) -> Self

Converts to this type from the input type.
source§

impl From<f32> for Action

source§

fn from(v: f32) -> Self

Converts to this type from the input type.
source§

impl From<f64> for Action

source§

fn from(v: f64) -> Self

Converts to this type from the input type.
source§

impl From<i8> for Action

source§

fn from(value: i8) -> Self

Converts to this type from the input type.
source§

impl Neg for Action

§

type Output = Action

The resulting type after applying the - operator.
source§

fn neg(self) -> Self::Output

Performs the unary - operation. Read more
source§

impl Ord for Action

source§

fn cmp(&self, other: &Action) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Action

source§

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

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

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.
source§

impl PartialOrd for Action

source§

fn partial_cmp(&self, other: &Action) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Serialize for Action

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Sub for Action

§

type Output = Action

The resulting type after applying the - operator.
source§

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation. Read more
source§

impl Copy for Action

source§

impl Eq for Action

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,