Skip to main content

AdoptionPlan

Struct AdoptionPlan 

Source
pub struct AdoptionPlan { /* private fields */ }
Expand description

An organization’s proposed Rakkotan adoption.

Implementations§

Source§

impl AdoptionPlan

Source

pub fn new(organization: impl Into<String>) -> Result<Self, AdoptionError>

Creates an unassessed plan for a non-blank organization name.

Examples found in repository?
examples/review_adoption.rs (line 4)
3fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let plan = AdoptionPlan::new("Example Corp")?
5        .assess(
6            P::PurposeAndOutcome,
7            Finding::Satisfied,
8            "pilot goal is measurable",
9        )?
10        .assess(
11            P::AuthorityAndTerms,
12            Finding::Satisfied,
13            "approver and terms recorded",
14        )?
15        .assess(
16            P::DataGovernance,
17            Finding::Satisfied,
18            "data flow and retention recorded",
19        )?
20        .assess(
21            P::UserProtection,
22            Finding::Satisfied,
23            "support and access needs reviewed",
24        )?
25        .assess(
26            P::OperationalOwnership,
27            Finding::NeedsRevision,
28            "backup owner is not assigned",
29        )?
30        .assess(
31            P::ReversibleAdoption,
32            Finding::Satisfied,
33            "exit process documented",
34        )?;
35
36    let report = AdoptionPolicy::evaluate(&plan);
37    println!("organization: {}", plan.organization());
38    println!("decision: {:?}", report.decision());
39    println!("unresolved: {:?}", report.unresolved());
40    Ok(())
41}
Source

pub fn assess( self, principle: AdoptionPrinciple, finding: Finding, evidence: impl Into<String>, ) -> Result<Self, AdoptionError>

Adds or replaces an assessment and returns the plan for chaining.

Examples found in repository?
examples/review_adoption.rs (lines 5-9)
3fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let plan = AdoptionPlan::new("Example Corp")?
5        .assess(
6            P::PurposeAndOutcome,
7            Finding::Satisfied,
8            "pilot goal is measurable",
9        )?
10        .assess(
11            P::AuthorityAndTerms,
12            Finding::Satisfied,
13            "approver and terms recorded",
14        )?
15        .assess(
16            P::DataGovernance,
17            Finding::Satisfied,
18            "data flow and retention recorded",
19        )?
20        .assess(
21            P::UserProtection,
22            Finding::Satisfied,
23            "support and access needs reviewed",
24        )?
25        .assess(
26            P::OperationalOwnership,
27            Finding::NeedsRevision,
28            "backup owner is not assigned",
29        )?
30        .assess(
31            P::ReversibleAdoption,
32            Finding::Satisfied,
33            "exit process documented",
34        )?;
35
36    let report = AdoptionPolicy::evaluate(&plan);
37    println!("organization: {}", plan.organization());
38    println!("decision: {:?}", report.decision());
39    println!("unresolved: {:?}", report.unresolved());
40    Ok(())
41}
Source

pub fn set_assessment( &mut self, principle: AdoptionPrinciple, finding: Finding, evidence: impl Into<String>, ) -> Result<(), AdoptionError>

Adds or replaces one assessment in place.

Source

pub fn organization(&self) -> &str

Returns the organization name.

Examples found in repository?
examples/review_adoption.rs (line 37)
3fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let plan = AdoptionPlan::new("Example Corp")?
5        .assess(
6            P::PurposeAndOutcome,
7            Finding::Satisfied,
8            "pilot goal is measurable",
9        )?
10        .assess(
11            P::AuthorityAndTerms,
12            Finding::Satisfied,
13            "approver and terms recorded",
14        )?
15        .assess(
16            P::DataGovernance,
17            Finding::Satisfied,
18            "data flow and retention recorded",
19        )?
20        .assess(
21            P::UserProtection,
22            Finding::Satisfied,
23            "support and access needs reviewed",
24        )?
25        .assess(
26            P::OperationalOwnership,
27            Finding::NeedsRevision,
28            "backup owner is not assigned",
29        )?
30        .assess(
31            P::ReversibleAdoption,
32            Finding::Satisfied,
33            "exit process documented",
34        )?;
35
36    let report = AdoptionPolicy::evaluate(&plan);
37    println!("organization: {}", plan.organization());
38    println!("decision: {:?}", report.decision());
39    println!("unresolved: {:?}", report.unresolved());
40    Ok(())
41}
Source

pub fn assessment(&self, principle: AdoptionPrinciple) -> Option<&Assessment>

Returns an assessment when recorded.

Trait Implementations§

Source§

impl Clone for AdoptionPlan

Source§

fn clone(&self) -> AdoptionPlan

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 AdoptionPlan

Source§

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

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

impl Eq for AdoptionPlan

Source§

impl PartialEq for AdoptionPlan

Source§

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

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, 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.