Skip to main content

Millis

Struct Millis 

Source
pub struct Millis(/* private fields */);
Expand description

A duration in whole milliseconds.

Weights are integers rather than floating-point seconds so that ordering is total, sums are exact, and identical input produces identical output on every platform. Cargo reports two decimal places of seconds, so milliseconds lose nothing that was ever measured.

Arithmetic saturates rather than overflowing, so a graph with absurd weights produces an absurd answer instead of a panic or a wrapped one.

use critpath_core::Millis;

let a = Millis::new(1_500);
let b = Millis::new(250);
assert_eq!(a.saturating_add(b), Millis::new(1_750));
assert_eq!(b.saturating_sub(a), Millis::ZERO);
assert_eq!(a.to_string(), "1500ms");

Implementations§

Source§

impl Millis

Source

pub const ZERO: Self

No time at all.

Source

pub const fn new(ms: u64) -> Self

A duration of ms milliseconds.

Examples found in repository?
examples/scaling.rs (line 46)
31fn build(units: usize, fan_in: usize) -> Result<BuildGraph, Box<dyn Error>> {
32    let tenths = NonZeroU64::new(10).ok_or("ten is not zero")?;
33    let mut builder = GraphBuilder::with_capacity(units);
34    let mut ids = Vec::with_capacity(units);
35    for i in 0..units {
36        let total = weight(i);
37        let unit = Unit {
38            package: format!("p{i}"),
39            version: "1.0.0".to_owned(),
40            target: format!("t{i}"),
41            kind: if is_opaque(i) {
42                UnitKind::ProcMacro
43            } else {
44                UnitKind::Lib
45            },
46            total: Millis::new(total),
47            // A library emits metadata about seven tenths of the way through, which is what the
48            // dev-profile builds measured in docs/validation.md do.
49            metadata_at: if is_opaque(i) {
50                None
51            } else {
52                Some(Millis::new(total).scaled(7, tenths))
53            },
54            requires_full_closure: is_opaque(i),
55        };
56        ids.push(builder.add_unit(unit)?);
57    }
58    for i in 0..units {
59        for k in 1..=fan_in {
60            let Some(back) = i.checked_sub(k * 3) else {
61                continue;
62            };
63            let (Some(&from), Some(&to)) = (ids.get(back), ids.get(i)) else {
64                continue;
65            };
66            // A metadata edge requires the producer to emit metadata and the consumer not to link.
67            let kind = if !is_opaque(back) && !is_opaque(i) {
68                EdgeKind::Metadata
69            } else {
70                EdgeKind::Full
71            };
72            builder.add_edge(from, to, kind)?;
73        }
74    }
75    Ok(builder.build()?)
76}
Source

pub const fn get(self) -> u64

The duration as a count of milliseconds.

Source

pub const fn saturating_add(self, other: Self) -> Self

The sum, clamped to the maximum representable duration.

Source

pub const fn saturating_sub(self, other: Self) -> Self

The difference, clamped at zero. There are no negative durations.

Source

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

The larger of two durations.

Source

pub fn div_ceil_by(self, divisor: NonZeroU64) -> Self

This duration divided by divisor, rounded up.

Rounding up matters because this computes the area bound total_work / J, which is a lower bound on the makespan. Rounding down would report a bound that no schedule can achieve.

Source

pub fn scaled(self, numerator: u64, denominator: NonZeroU64) -> Self

This duration scaled by the fraction numerator / denominator, rounded to nearest.

Used to divide a unit’s weight between the halves of a hypothetical split. Widening to 128 bits keeps the product exact for any duration a real build could produce.

Examples found in repository?
examples/scaling.rs (line 52)
31fn build(units: usize, fan_in: usize) -> Result<BuildGraph, Box<dyn Error>> {
32    let tenths = NonZeroU64::new(10).ok_or("ten is not zero")?;
33    let mut builder = GraphBuilder::with_capacity(units);
34    let mut ids = Vec::with_capacity(units);
35    for i in 0..units {
36        let total = weight(i);
37        let unit = Unit {
38            package: format!("p{i}"),
39            version: "1.0.0".to_owned(),
40            target: format!("t{i}"),
41            kind: if is_opaque(i) {
42                UnitKind::ProcMacro
43            } else {
44                UnitKind::Lib
45            },
46            total: Millis::new(total),
47            // A library emits metadata about seven tenths of the way through, which is what the
48            // dev-profile builds measured in docs/validation.md do.
49            metadata_at: if is_opaque(i) {
50                None
51            } else {
52                Some(Millis::new(total).scaled(7, tenths))
53            },
54            requires_full_closure: is_opaque(i),
55        };
56        ids.push(builder.add_unit(unit)?);
57    }
58    for i in 0..units {
59        for k in 1..=fan_in {
60            let Some(back) = i.checked_sub(k * 3) else {
61                continue;
62            };
63            let (Some(&from), Some(&to)) = (ids.get(back), ids.get(i)) else {
64                continue;
65            };
66            // A metadata edge requires the producer to emit metadata and the consumer not to link.
67            let kind = if !is_opaque(back) && !is_opaque(i) {
68                EdgeKind::Metadata
69            } else {
70                EdgeKind::Full
71            };
72            builder.add_edge(from, to, kind)?;
73        }
74    }
75    Ok(builder.build()?)
76}

Trait Implementations§

Source§

impl Clone for Millis

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Millis

Source§

impl Debug for Millis

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Millis

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for Millis

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Millis

Source§

impl Hash for Millis

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Millis

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

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. Read more
Source§

impl PartialEq for Millis

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Millis

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for Millis

Source§

impl Sum for Millis

Source§

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.