Struct SIPParams

pub struct SIPParams {
    pub trading_symbol: String,
    pub amount: f64,
    pub instalments: Option<u32>,
    pub frequency: SIPFrequency,
    pub initial_amount: Option<f64>,
    pub tag: Option<String>,
}

SIP creation parameters

Fields

trading_symbol: String

Trading symbol

amount: f64

Installment amount

instalments: Option<u32>

Number of installments (optional for perpetual SIP)

frequency: SIPFrequency

Frequency

initial_amount: Option<f64>

Initial amount (for first installment, optional)

tag: Option<String>

Tag

Implementations

impl SIPParams

pub fn new(trading_symbol: String, amount: f64, frequency: SIPFrequency) -> Self

Create a new SIP

pub fn instalments(self, instalments: u32) -> Self

Set number of installments

pub fn initial_amount(self, initial_amount: f64) -> Self

Set initial amount

pub fn tag<S: Into<String>>(self, tag: S) -> Self

Set tag

pub fn monthly(trading_symbol: String, amount: f64) -> Self

Create monthly SIP

pub fn weekly(trading_symbol: String, amount: f64) -> Self

Create weekly SIP

pub fn daily(trading_symbol: String, amount: f64) -> Self

Create daily SIP

pub fn validate(&self) -> Result<(), String>

Validate SIP parameters

Trait Implementations

impl Clone for SIPParams

fn clone(&self) -> SIPParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SIPParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SIPParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SIPParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.