Struct DividendOptions 

pub struct DividendOptions {
    pub share_count: usize,
    pub dividend_options: Vec<(DividendKind, Rounding)>,
}

The dividend options for a company.

Fields

share_count: usize

The total number of shares.

dividend_options: Vec<(DividendKind, Rounding)>

The available dividend options.

Implementations

impl DividendOptions

pub fn dividends(&self, revenue: usize) -> Vec<Dividends>

Returns the per-share dividend to distribute the provided revenue, for each of the available dividend options.

Trait Implementations

impl Clone for DividendOptions

fn clone(&self) -> DividendOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DividendOptions

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

Formats the value using the given formatter.

impl Ord for DividendOptions

fn cmp(&self, other: &DividendOptions) -> 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 DividendOptions

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for DividendOptions

fn partial_cmp(&self, other: &DividendOptions) -> 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 Eq for DividendOptions

impl StructuralPartialEq for DividendOptions