Skip to main content

OrbState

quantwave_core::indicators::session_levels

Struct OrbState

pub struct OrbState {
    pub phase: OrbPhase,
    pub breakout: OrbBreakout,
    pub range_high: f64,
    pub range_low: f64,
    pub range_size: f64,
    pub target_1_bull: f64,
    pub target_1_bear: f64,
    pub target_2_bull: f64,
    pub target_2_bear: f64,
    pub bar_index: usize,
}

Expand description

Output state of the Opening Range Breakout (ORB) indicator.

Fields§

§phase: OrbPhase

Current lifecycle phase of the session.

§breakout: OrbBreakout

Breakout status evaluated on the current bar close.

§range_high: f64

Established or in-progress high of the opening range.

§range_low: f64

Established or in-progress low of the opening range.

§range_size: f64

Height of the opening range (range_high - range_low).

§target_1_bull: f64

Bullish extension target 1 (range_high + 0.5 * range_size).

§target_1_bear: f64

Bearish extension target 1 (range_low - 0.5 * range_size).

§target_2_bull: f64

Bullish extension target 2 (range_high + 1.0 * range_size).

§target_2_bear: f64

Bearish extension target 2 (range_low - 1.0 * range_size).

§bar_index: usize

0-indexed count of bars processed in the current session.

Implementations§

impl OrbState

pub const fn is_breakout(&self) -> bool

Returns true if the bar closed with a breakout in either direction.

pub fn target_1_reached(&self, price: f64) -> bool

Returns true if target 1 was reached or exceeded by the provided price.

pub fn target_2_reached(&self, price: f64) -> bool

Returns true if target 2 was reached or exceeded by the provided price.

Trait Implementations§

impl Clone for OrbState

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Copy for OrbState

impl Debug for OrbState

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for OrbState

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

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for OrbState

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl Serialize for OrbState

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

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for OrbState

Auto Trait Implementations§

impl Forget for OrbState

impl Freeze for OrbState

impl Move for OrbState

impl RefUnwindSafe for OrbState

impl Send for OrbState

impl Sync for OrbState

impl Unpin for OrbState

impl UnsafeUnpin for OrbState

impl UnwindSafe for OrbState

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

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.

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

Performs the conversion.