Struct FmtWrapper 

pub struct FmtWrapper<T>(pub T);

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::traits::sync::DirStructureItem;
use dir_structure::fmt_wrapper::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

impl<T> AssertEq for FmtWrapper<T>

where for<'__trivial> T: AssertEq<T> + Debug,

fn assert_eq( &self, other: &Self, path: &mut AssertPath, init_left: &impl Display, init_right: &impl Display, )

Asserts that self is equal to other, panicking if they are not equal.

impl<'a, 'vfs, T, Vfs> FromRefForWriter<'a, 'vfs, Vfs> for FmtWrapper<T>

where T: Display + 'a, Vfs: 'vfs + WriteSupportingVfs<'vfs>, 'vfs: 'a,

type Inner = T

The inner type to cast.

type Wr = FmtWrapperRefWr<'a, 'vfs, T, Vfs>

The reference type to cast to.

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

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

impl<'a, T, Vfs: WriteSupportingVfsAsync + 'static> FromRefForWriterAsync<'a, Vfs> for FmtWrapper<T>

where T: Display + Send + 'a,

Available on crate feature async only.

type Inner = T

The inner type to cast.

type Wr = FmtWrapperRefWr<'a, 'a, T, Vfs>

The reference type to cast to.

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

Casts the reference to the inner type to a WriteToAsync reference type.

impl<T> NewtypeToInner for FmtWrapper<T>

type Inner = T

The inner type.

fn into_inner(self) -> Self::Inner

Converts the newtype to its inner type.

impl<'a, T, Vfs: Vfs<'a>> ReadFrom<'a, Vfs> for FmtWrapper<T>

where T: FromStr + 'a, T::Err: Into<Box<dyn Error + Send + Sync>>,

fn read_from(path: &Vfs::Path, vfs: Pin<&'a Vfs>) -> VfsResult<Self, Vfs>

where Self: Sized,

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

impl<'a, T, Vfs: VfsAsync + 'static> ReadFromAsync<'a, Vfs> for FmtWrapper<T>

where T: FromStr + Send + 'static, T::Err: Into<Box<dyn Error + Send + Sync>>,

Available on crate feature async only.

type Future = Pin<Box<dyn Future<Output = Result<FmtWrapper<T>, Error<<<Vfs as VfsCore>::Path as PathType>::OwnedPath>>> + Send + 'a>>

The future type returned by the async read function.

fn read_from_async( path: <<Vfs as VfsCore>::Path as PathType>::OwnedPath, vfs: Pin<&'a Vfs>, ) -> Self::Future

Asynchronously reads the structure from the specified path, which can be either a file or a directory.

impl<'vfs, T, Vfs: WriteSupportingVfs<'vfs>> WriteTo<'vfs, Vfs> for FmtWrapper<T>

where T: Display,

fn write_to(&self, path: &Vfs::Path, vfs: Pin<&'vfs Vfs>) -> VfsResult<(), Vfs>

Writes the structure to the specified path.

impl<'a, T, Vfs: WriteSupportingVfsAsync + 'static> WriteToAsync<'a, Vfs> for FmtWrapper<T>

where T: Display + Send + Sync + 'static,

Available on crate feature async only.

type Future = <FileString as WriteToAsync<'a, Vfs>>::Future

The future type returned by the async write function.

fn write_to_async( self, path: <<Vfs as VfsCore>::Path as PathType>::OwnedPath, vfs: Pin<&'a Vfs>, ) -> Self::Future

Asynchronously writes the structure to the specified path.

impl<'a, T, Vfs: WriteSupportingVfsAsync + 'static> WriteToAsyncRef<'a, Vfs> for FmtWrapper<T>

where T: Display + Send + Sync + 'a,

Available on crate feature async only.

type Future<'b> = <FileString as WriteToAsync<'b, Vfs>>::Future where Self: 'b, Vfs: 'b, 'a: 'b

The future type returned by the async write function.

fn write_to_async_ref<'b>( &'b self, path: <<Vfs as VfsCore>::Path as PathType>::OwnedPath, vfs: Pin<&'b Vfs>, ) -> Self::Future<'b>

where 'a: 'b,

Asynchronously writes the structure to the specified path.