Struct Finalizers 

pub struct Finalizers {
    inner: Vec<FinalizerId>,
}

A sequence of FinalizerIds that should be processed in the right order, one by one. Deletion may performed only if there is no FinalizerId left to process.

Similar to a Stack except that no new elements can be pushed to the data structure after it has been created.

Examples

use scl_lib::api_objects::{Finalizers, FinalizerId::*};
let fs = vec![ForceRemoveVMs, ForceRemoveVolumes];
let mut finalizers = Finalizers::from(fs);
assert_eq!(finalizers.take_next_finalizer(), Some(ForceRemoveVMs));
assert_eq!(finalizers.next_finalizer(), Some(&ForceRemoveVolumes));
let _ = finalizers.take_next_finalizer();
assert!(finalizers.may_be_deleted());

Fields

inner: Vec<FinalizerId>

Implementations

impl Finalizers

pub fn may_be_deleted(&self) -> bool

Returns true if no finalizer remains.

pub fn next_finalizer(&self) -> Option<&FinalizerId>

Returns a reference of the next FinalizerId that should be processed.

pub fn take_next_finalizer(&mut self) -> Option<FinalizerId>

Pops the next FinalizerId that should be processed.

pub fn identify_removed_finalizer( current_state: &Self, proposed_new_state: &Self, ) -> Result<FinalizerId>

Identifies which finalizer has been removed.

The function performs a transition validation since this is a prerequisite.

pub fn iter(&self) -> Iter<'_, FinalizerId>

Provides an iterator over the finalizers.

Trait Implementations

impl Clone for Finalizers

fn clone(&self) -> Finalizers

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Finalizers

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Finalizers

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Vec<FinalizerId>> for Finalizers

fn from(vec: Vec<FinalizerId>) -> Self

Converts to this type from the input type.

impl Ord for Finalizers

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Finalizers

impl StructuralPartialEq for Finalizers