Struct SomeMut 

pub struct SomeMut<'a, T>(/* private fields */);

A mutable reference to an Option that is guaranteed to always be Some.

Implementations

impl<'a, T> SomeMut<'a, T>

pub fn take(self) -> T

Take the value from this SomeMut, leaving a None in the original option.

Examples

use some_mut::OptionExt;

let mut x = Some(vec![42, 10, 12]);
let mut y = 0;
let mut z = vec![];
for i in 0..5 {
    if let Some(x) = x.some_mut() {
        y += 2;
        if y >= 4 {
            z = x.take();
        }
    } else {
        z.push(i)
    }
}

assert!(x.is_none());
assert_eq!(y, 4);
assert_eq!(z, [42, 10, 12, 2, 3, 4])

pub fn into_mut(self) -> &'a mut T

Unwrap this SomeMut into a normal mutable reference, with a lifetime tied to the original option.

pub fn into_option_mut(self) -> &'a mut Option<T>

Unwrap this SomeMut into a mutable reference to the original option.

Trait Implementations

impl<T> AsMut<T> for SomeMut<'_, T>

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsRef<T> for SomeMut<'_, T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Borrow<T> for SomeMut<'_, T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: Debug> Debug for SomeMut<'_, T>

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

Formats the value using the given formatter.

impl<T> Deref for SomeMut<'_, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for SomeMut<'_, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Display> Display for SomeMut<'_, T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq<T> for SomeMut<'_, T>

fn eq(&self, other: &T) -> 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<T: PartialOrd> PartialOrd<T> for SomeMut<'_, T>

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