Struct PeriodLength 

pub struct PeriodLength(/* private fields */);

Positive lookback / window length for technical indicators (usize ≥ 1).

Distinct from Periods (u32 TVM counts) so TA windows do not silently mix with NPER.

Implementations

impl PeriodLength

pub fn new(n: usize) -> FinanceResult<Self>

Fallible constructor: n >= 1.

pub const fn new_const(n: usize) -> Self

const constructor for known-valid compile-time windows (e.g. 20 for SMA-20).

Panics in debug if n == 0; release builds still store 0 — prefer PeriodLength::new for runtime input. For const presets, only pass literals ≥ 1.

pub const fn get(self) -> usize

Trait Implementations

impl Clone for PeriodLength

fn clone(&self) -> PeriodLength

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PeriodLength

impl Debug for PeriodLength

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

Formats the value using the given formatter.

impl Display for PeriodLength

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

Formats the value using the given formatter.

impl Eq for PeriodLength

impl From<PeriodLength> for usize

fn from(p: PeriodLength) -> usize

Converts to this type from the input type.

impl Hash for PeriodLength

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PeriodLength

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PeriodLength

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PeriodLength

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for PeriodLength

impl TryFrom<usize> for PeriodLength

type Error = FinanceError

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.