Struct Share 

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

Billionths of the whole plan.

Ordered so a renderer can sort branches by weight without unwrapping the number first.

Implementations

impl Share

pub const WHOLE: Share

The whole plan. The one origin: every other share descends from this one by division.

pub const NONE: Share

Nothing at all — what a branch with no leaves has done.

Safe to expose because it cannot grow: no addition exists on this type, so a zero cannot be turned into a claim on the plan.

pub fn ppb(self) -> u64

This share in billionths of the whole plan.

pub fn split(self, weights: &[u32]) -> Result<Vec<Share>, AxError>

Divides this share among weights, consuming it.

The parts add up to the input exactly. Integer division leaves a remainder of fewer billionths than there are parts, and it goes to the earliest parts one at a time — a rule rather than a rounding, so the same plan divides the same way on every machine.

Errors

Refuses an empty list and refuses weights that are all zero: both ask for a division with no dividend, and answering them would mean either losing the share or inventing a rule about where it went.

Trait Implementations

impl Clone for Share

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Share

impl Debug for Share

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

Formats the value using the given formatter.

impl Eq for Share

impl Ord for Share

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Share

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Share

fn partial_cmp(&self, other: &Self) -> 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 Share