Skip to main content

Sprint

Struct Sprint 

Source
pub struct Sprint {
    pub id: SprintId,
    pub title: String,
    pub goal: String,
    pub start: Option<DateTime<Utc>>,
    pub end: Option<DateTime<Utc>>,
    pub daily_work_hours: Option<f64>,
    pub holiday_days: Option<u32>,
    pub deduction_factor: Option<f64>,
    pub state: SprintState,
    pub created: DateTime<Utc>,
    pub updated: DateTime<Utc>,
}
Expand description

A sprint that groups PBIs into a time-boxed work period.

start and end are planned dates independent of state transitions; editing sets the schedule while Sprint::start and Sprint::close advance the state.

Fields§

§id: SprintId

Stable identifier.

§title: String

Display title.

§goal: String

Sprint goal (free description, multiple lines allowed).

§start: Option<DateTime<Utc>>

Planned start date and time, or None when unset.

§end: Option<DateTime<Utc>>

Planned end date and time, or None when unset.

§daily_work_hours: Option<f64>

Working hours per day; capacity is unavailable when unset.

§holiday_days: Option<u32>

Holidays within the period, deducted from the inclusive calendar-day count.

§deduction_factor: Option<f64>

Fraction of daily capacity retained after meetings and interruptions (0.0..=1.0).

§state: SprintState

Current state (planned, active, or closed).

§created: DateTime<Utc>§updated: DateTime<Utc>

Implementations§

Source§

impl Sprint

Source

pub fn new( id: SprintId, title: impl Into<String>, now: DateTime<Utc>, ) -> Result<Self>

Create a minimal sprint in SprintState::Planned with an empty goal and no schedule.

Return Error::EmptySprintTitle when title is empty or only whitespace.

Source

pub fn update_details( &mut self, title: Option<String>, goal: Option<String>, period: Option<(DateTime<Utc>, DateTime<Utc>)>, now: DateTime<Utc>, ) -> Result<()>

Update the editable sprint details and refresh updated.

Fields set to None remain unchanged. A blank title or inverted period is rejected before any field changes are applied. Return Error::NothingToUpdate when no field is supplied.

Source

pub fn start(&mut self, now: DateTime<Utc>) -> Result<()>

Start a sprint (plannedactive) and update updated.

A sprint without a non-blank goal is rejected with Error::EmptySprintGoal. Return Error::InvalidSprintTransition for any other starting state without changing it.

Source

pub fn close(&mut self, now: DateTime<Utc>) -> Result<()>

Close a sprint (activeclosed) and update updated.

Return Error::InvalidSprintTransition for any other state without changing it.

Source

pub fn set_capacity( &mut self, daily_work_hours: f64, holiday_days: u32, deduction_factor: f64, ) -> Result<()>

Update settings for capacity calculations.

Count calendar days inclusively, subtract holiday_days, and multiply the result by daily_work_hours × deduction_factor. Reject an unset period or invalid value without changing existing settings.

Source

pub fn capacity(&self) -> Option<SprintCapacity>

Return working days and available hours when the schedule and capacity settings are complete.

Trait Implementations§

Source§

impl Clone for Sprint

Source§

fn clone(&self) -> Sprint

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 Debug for Sprint

Source§

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

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

impl PartialEq for Sprint

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Sprint

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> AnyEq for T
where T: Any + PartialEq,

Source§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

Source§

fn as_any(&self) -> &(dyn Any + 'static)

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.