FromReader

Trait FromReader

pub trait FromReader: Sized {
    // Required method
    fn from_reader<R>(r: &mut R) -> Result<Self>
       where R: Read;
}

Expand description

Marks a type as able to be deserialized from a reader.

If you are implementing this trait, make sure tora’s derive macros are inapplicable to your use case.

§Examples

use std::io;
use std::io::Read;

use tora::read::{FromReader, ToraRead};

struct CustomVec {
    extended_capacity: u32,
    content: Vec<u8>
}

impl FromReader for CustomVec {
    fn from_reader<R>(r: &mut  R) -> io::Result<Self>
    where
        R: Read,
    {
        Ok(Self {
            extended_capacity: r.reads()?,
            content: r.reads()?
        })
    }
}

Required Methods§

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types§

impl FromReader for bool

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

Reads a bool from this reader.

Returns true if the read u8 is not zero.

impl FromReader for char

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

Reads a character from this reader.

Returns ErrorKind::InvalidData if the read u32 cannot be converted to a char.

impl FromReader for f32

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

impl FromReader for f64

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

impl FromReader for i8

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

impl FromReader for i16

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

impl FromReader for i32

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

impl FromReader for i64

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

impl FromReader for i128

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

impl FromReader for u8

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

impl FromReader for u16

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

impl FromReader for u32

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

impl FromReader for u64

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

impl FromReader for u128

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

impl FromReader for ()

fn from_reader<R>(_r: &mut R) -> Result<Self>
where R: Read,

Immediately returns Ok of unit value.

impl FromReader for usize

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

impl FromReader for String

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

Read a UTF-8 string from this reader.

Reads until a NUL 0x00 byte is encountered. Does not include the terminating byte.

Returns ErrorKind::InvalidData if the received message is not valid UTF-8.

impl<T> FromReader for Option<T>
where T: FromReader,

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

Reads a bool and if true, reads and returns Some([T]).

impl<T> FromReader for Box<T>
where T: FromReader,

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

impl<T> FromReader for Vec<T>
where T: FromReader,

Available on crate feature dyn_impl only.

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

Reads a u32, then reads N amount of [T] into a Vec and returns it.

impl<T, E> FromReader for Result<T, E>
where T: FromReader, E: FromReader,

fn from_reader<R>(r: &mut R) -> Result<Result<T, E>>
where R: Read,

Reads a boolean and if true, tries to deserialize the [E] type, else [T].

impl<T, Z> FromReader for (T, Z)
where T: FromReader, Z: FromReader,

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

Reads a tuple of [T] and [Z], respectively.

impl<T, Z, H> FromReader for (T, Z, H)
where T: FromReader, Z: FromReader, H: FromReader,

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

Reads a tuple of [T], [Z], and [H], respectively.

impl<T, const N: usize> FromReader for [T; N]
where T: FromReader + Copy + Default,

fn from_reader<R>(r: &mut R) -> Result<Self>
where R: Read,

Reads and deserializes [N] amount of [T].

Implementors§