Struct FmtWrapper

Source
pub struct FmtWrapper<T>(pub T);
Expand description

A wrapper around a type which will use the Display and FromStr implementations for serialization / deserialization.

For example: u8, i8, i16, u16, all integer types… bool etc.

§Examples

use std::path::Path;
use dir_structure::DirStructureItem;

use dir_structure::FmtWrapper;

#[derive(dir_structure::DirStructure, PartialEq, Debug)]
struct Dir {
   #[dir_structure(path = "f.txt", with_newtype = FmtWrapper<u8>)]
   f: u8,
   #[dir_structure(path = "b.txt", with_newtype = FmtWrapper<bool>)]
   b: bool,
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let d = Path::new("dir");
    std::fs::create_dir_all(&d)?;
    std::fs::write(d.join("f.txt"), "42")?;
    std::fs::write(d.join("b.txt"), "true")?;
    let mut dir = Dir::read(&d)?;
    assert_eq!(dir.f, 42);
    assert_eq!(dir.b, true);
    dir.f = 100;
    dir.b = false;
    dir.write(&d)?;
    assert_eq!(std::fs::read_to_string(d.join("f.txt"))?, "100");
    assert_eq!(std::fs::read_to_string(d.join("b.txt"))?, "false");
    Ok(())
}

Tuple Fields§

§0: T

Trait Implementations§

Source§

impl<'a, T> FromRefForWriter<'a> for FmtWrapper<T>
where T: Display + 'a,

Source§

type Inner = T

The inner type to cast.
Source§

type Wr = FmtWrapperRefWr<'a, T>

The reference type to cast to.
Source§

fn from_ref_for_writer(value: &'a Self::Inner) -> Self::Wr

Casts the reference to the inner type to a WriteTo reference type.
Source§

impl<T> NewtypeToInner for FmtWrapper<T>

Source§

type Inner = T

The inner type.
Source§

fn into_inner(self) -> Self::Inner

Converts the newtype to its inner type.
Source§

impl<T> ReadFrom for FmtWrapper<T>
where T: FromStr, T::Err: Into<Box<dyn Error + Send + Sync>>,

Source§

fn read_from(path: &Path) -> Result<Self>
where Self: Sized,

Reads the structure from the specified path, which can be either a file or a directory.
Source§

impl<T> WriteTo for FmtWrapper<T>
where T: Display,

Source§

fn write_to(&self, path: &Path) -> Result<()>

Writes the structure to the specified path.

Auto Trait Implementations§

§

impl<T> Freeze for FmtWrapper<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for FmtWrapper<T>
where T: RefUnwindSafe,

§

impl<T> Send for FmtWrapper<T>
where T: Send,

§

impl<T> Sync for FmtWrapper<T>
where T: Sync,

§

impl<T> Unpin for FmtWrapper<T>
where T: Unpin,

§

impl<T> UnwindSafe for FmtWrapper<T>
where T: UnwindSafe,

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> DirStructureItem for T
where T: ReadFrom + WriteTo,

Source§

fn read(path: impl AsRef<Path>) -> Result<Self>
where Self: Sized,

Uses the ReadFrom implementation to read the structure from disk, from the specified path.
Source§

fn write(&self, path: impl AsRef<Path>) -> Result<()>

Uses the WriteTo implementation to write the structure to disk at the specified path.
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.