Struct kai::Adapter

pub struct Adapter<'a, T> where
    T: FromStr + Display,  { /* fields omitted */ }

Wraps a reference to a String representation of some type

The String can be accessed as if it were the type. An Adapter can be made for any type that implements FromStr and Display. An Adapter must be dropped before the String can be accessed again.

Example

use kai::*;

// A `Vec` of number strings
let mut nums: Vec<String> = vec![
    "4".into(),
    "1".into(),
    "-1".into(),
];

// Iterate over `Adapters` that wrap the number strings
// The `Adapter`s can be modified as if they are numbers
for mut n in nums.iter_mut().filter_map(|s| Adapter::<i32>::from(s).ok()) {
    *n += 2;
    *n *= 2;
}

assert_eq!(
    vec!["12".to_string(), "6".into(), "2".into()],
    nums,
);

Methods

impl<'a, T> Adapter<'a, T> where
    T: FromStr + Display, 

pub fn from(string: &'a mut String) -> Result<Adapter<'a, T>, T::Err>

Create a new Adapter from a String

pub fn finish(self)

Force a drop, returning ownership to the string

This function only needs to be called if you want access to the string before the Adapter would normally be dropped.

Trait Implementations

impl<'a, T> Drop for Adapter<'a, T> where
    T: FromStr + Display, 

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T> AsRef<T> for Adapter<'a, T> where
    T: FromStr + Display, 

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?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<'a, T> DerefMut for Adapter<'a, T> where
    T: FromStr + Display, 

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

Mutably dereferences the value.

impl<'a, T> Deref for Adapter<'a, T> where
    T: FromStr + Display, 

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, T> Debug for Adapter<'a, T> where
    T: FromStr + Display + Debug, 

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

Formats the value using the given formatter.

impl<'a, T> Display for Adapter<'a, T> where
    T: FromStr + Display, 

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

Formats the value using the given formatter.

impl<'a, T> Borrow<T> for Adapter<'a, T> where
    T: FromStr + Display, 

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?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.