Struct kai::Swap

pub struct Swap<T>(_);

Wrapper that allows consuming transformations on borrowed data

This is useful when you want a mutable interface wrapping a functional one.

Example

use kai::*;

struct Foo {
    v: Swap<Vec<i32>>
}

impl Foo {
    fn keep_even(&mut self) {
        self.v.hold(|v| v.into_iter().filter(|n| n % 2 == 0).collect());
    }
}

let mut foo = Foo { v: vec![1, 2, 3, 4, 5].into() };
foo.keep_even();
assert_eq!(vec![2, 4], *foo.v);

Methods

impl<T> Swap<T>

pub fn new(inner: T) -> Self

Create a new Swap

pub fn hold<F>(&mut self, f: F) where
    F: FnOnce(T) -> T, 

Take the inner value, transform it, and put it back in place

pub fn into_inner(self) -> T

Take the inner value

Trait Implementations

impl<T: Copy> Copy for Swap<T>

impl<T: PartialEq> PartialEq<Swap<T>> for Swap<T>

fn eq(&self, other: &Swap<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Swap<T>) -> bool

This method tests for !=.

impl<T> AsRef<T> for Swap<T>

Important traits for &'_ mut R

impl<'_, R> Read for &'_ mut R where
    R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
    W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn as_ref(&self) -> &T

Performs the conversion.

impl<T> Default for Swap<T> where
    T: Default, 

fn default() -> Self

Returns the "default value" for a type.

impl<T: Clone> Clone for Swap<T>

fn clone(&self) -> Swap<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Ord> Ord for Swap<T>

fn cmp(&self, other: &Swap<T>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T> From<T> for Swap<T>

fn from(inner: T) -> Self

Performs the conversion.

impl<T: Eq> Eq for Swap<T>

impl<T: PartialOrd> PartialOrd<Swap<T>> for Swap<T>

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

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Swap<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Swap<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Swap<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Swap<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> DerefMut for Swap<T>

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

Mutably dereferences the value.

impl<T> Deref for Swap<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> Display for Swap<T> where
    T: Display, 

fn fmt(&self, f: &mut Formatter) -> FmtResult

Formats the value using the given formatter.

impl<T> Debug for Swap<T> where
    T: Debug, 

fn fmt(&self, f: &mut Formatter) -> FmtResult

Formats the value using the given formatter.

impl<T: Hash> Hash for Swap<T>

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<T> Borrow<T> for Swap<T>

Important traits for &'_ mut R

impl<'_, R> Read for &'_ mut R where
    R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
    W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

fn borrow(&self) -> &T

Immutably borrows from an owned value.