Skip to main content

Member

Struct Member 

Source
#[non_exhaustive]
pub struct Member { pub change: f64, pub volume: f64, pub new_high: bool, pub new_low: bool, pub above_ma: bool, pub on_buy_signal: bool, }
Expand description

One symbol’s contribution to a CrossSection tick.

Field invariants enforced by CrossSection::new when the member is placed into a tick:

  • change is finite (its sign classifies the symbol — positive is advancing, negative is declining, zero is unchanged).
  • volume is finite and non-negative.

new_high / new_low are caller-supplied flags marking whether the symbol printed a new period extreme; above_ma / on_buy_signal are caller-supplied per-symbol state signals (whether the symbol trades above its reference moving average, and whether it is on a point-and-figure buy signal). None of the four flags carries a numeric invariant.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§change: f64

Price change versus the previous close. Sign classifies the symbol: positive is advancing, negative is declining, zero is unchanged.

§volume: f64

Period volume for the symbol (finite, non-negative).

§new_high: bool

Whether the symbol printed a new period high.

§new_low: bool

Whether the symbol printed a new period low.

§above_ma: bool

Whether the symbol is trading above its reference moving average (consumed by the % Above Moving Average breadth indicator).

§on_buy_signal: bool

Whether the symbol is on a point-and-figure buy signal (consumed by the Bullish Percent Index breadth indicator).

Implementations§

Source§

impl Member

Source

pub const fn new( change: f64, volume: f64, new_high: bool, new_low: bool, ) -> Self

Assemble a cross-section member from its core signals, leaving the extended per-symbol state flags (above_ma, on_buy_signal) cleared.

The field invariants documented on Member are validated centrally by CrossSection::new when the member is placed into a tick; this constructor only assembles the value so the #[non_exhaustive] struct can be built from outside the crate.

Source

pub const fn with_signals( change: f64, volume: f64, new_high: bool, new_low: bool, above_ma: bool, on_buy_signal: bool, ) -> Self

Assemble a cross-section member including the extended per-symbol state signals above_ma and on_buy_signal.

Use this constructor for the breadth indicators that read per-symbol state (% Above Moving Average, Bullish Percent Index); new is the shorthand that leaves both flags false.

Trait Implementations§

Source§

impl Clone for Member

Source§

fn clone(&self) -> Member

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
Source§

impl Copy for Member

Source§

impl Debug for Member

Source§

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

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

impl PartialEq for Member

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for Member

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> CloneToUninit for T
where T: Clone,

Source§

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
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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.