Struct Series 

pub struct Series<T> { /* private fields */ }

A bar-aligned series of values.

Internally this is backed by a VecDeque and is used to represent Pine-like series variables (one value per bar). You don’t construct Series directly; it is returned by visual primitives like Plot.

Examples

use navi_types::Series;

// Series is typically constructed internally; here we use from_queue for testing.
let mut s: Series<f64> = Series::from_queue(vec![1.0, 2.0, 3.0].into());
assert_eq!(s.len(), 3);
assert_eq!(s.get(0), Some(&1.0));
assert_eq!(s.last(), Some(&3.0));

for val in &s {
    let _ = *val;
}

Implementations

impl<T> Series<T>

pub fn from_queue(queue: VecDeque<T>) -> Series<T>

Creates a Series from an existing VecDeque.

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over references to the elements.

impl<T> Series<T>

where T: Default,

pub fn new() -> Series<T>

Creates an empty series.

pub fn update(&mut self, value: T)

Updates the last element in the series.

Panics

Panics if the series is empty.

pub fn truncate(&mut self, length: usize) -> usize

Removes elements from the front to keep at most length elements. Returns the number of elements removed.

pub fn append_new(&mut self)

Appends a new default-initialized element.

pub fn get(&self, index: usize) -> Option<&T>

Returns the value at index, or None if out of bounds.

pub fn len(&self) -> usize

Returns the number of elements in the series.

pub fn is_empty(&self) -> bool

Returns true if the series contains no elements.

pub fn last(&self) -> Option<&T>

Returns the last element in the series, or None if empty.

Trait Implementations

impl<T> Clone for Series<T>

where T: Clone,

fn clone(&self) -> Series<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Series<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Series<T>

where T: Default,

fn default() -> Series<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Series<T>

where T: Deserialize<'de>,

fn deserialize<D>( deserializer: D, ) -> Result<Series<T>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Index<usize> for Series<T>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &<Series<T> as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl<'a, T> IntoIterator for &'a Series<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a Series<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for Series<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Series<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> Serialize for Series<T>

where T: Serialize,

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

where S: Serializer,

Serialize this value into the given Serde serializer.