Trait Decode 

pub trait Decode: Sized {
    type Error;

    // Required method
    fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>;
}

Denotes a type capable of being decoded.

This trait can be derived for custom types using the Decode derive macro.

Do remember that this macro assumes that the Encode trait has not been manually implemented (i.e. it must either be not implemented or derived). Breaking this promise is a logic error and can lead to failed decodings.

See also the decode module’s documentation on how to use decodings.

Required Associated Types

type Error

The type returned in case of error.

Required Methods

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

Decodes an object from the provided input.

Errors

If decoding fails due to e.g. an invalid byte sequence in the input, then an error should be returned.

Panics

If input unexpectedly terminates before a full encoding was read, then this method should panic.

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 Decode for Infallible

type Error = Infallible

fn decode(_input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for c_void

type Error = Infallible

fn decode(_input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for IpAddr

type Error = EnumDecodeError<u8, <u8 as Decode>::Error, Infallible>

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for SocketAddr

type Error = EnumDecodeError<u8, <u8 as Decode>::Error, Infallible>

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for bool

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

Lossily reinterprets a byte value as a boolean.

Whilst Encode::encode will only yield the values 0 and 1, this method clamps all values above 1.

type Error = BoolDecodeError

impl Decode for char

type Error = CharDecodeError

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for f16

Available on crate feature f16 only.

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for f32

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for f64

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for f128

Available on crate feature f128 only.

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for i8

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for i16

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for i32

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for i64

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for i128

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for isize

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for u8

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for u16

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for u32

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for u64

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for u128

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for ()

type Error = Infallible

fn decode(_input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for usize

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for CString

Available on crate feature alloc only.

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

Decodes a byte slice from the input.

This implementation will always allocate one more byte than specified by the slice for the null terminator. Note that any null value already in the data will truncate the final string.

type Error = <Vec<u8> as Decode>::Error

impl Decode for String

Available on crate feature alloc only.

type Error = CollectionDecodeError<Infallible, Utf8Error>

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for PhantomPinned

type Error = Infallible

fn decode(_input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for Ipv4Addr

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for Ipv6Addr

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for SocketAddrV4

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for SocketAddrV6

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for NonZero<i8>

type Error = NonZeroDecodeError

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for NonZero<i16>

type Error = NonZeroDecodeError

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for NonZero<i32>

type Error = NonZeroDecodeError

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for NonZero<i64>

type Error = NonZeroDecodeError

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for NonZero<i128>

type Error = NonZeroDecodeError

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for NonZero<isize>

type Error = NonZeroDecodeError

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for NonZero<u8>

type Error = NonZeroDecodeError

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for NonZero<u16>

type Error = NonZeroDecodeError

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for NonZero<u32>

type Error = NonZeroDecodeError

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for NonZero<u64>

type Error = NonZeroDecodeError

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for NonZero<u128>

type Error = NonZeroDecodeError

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for NonZero<usize>

type Error = NonZeroDecodeError

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for RangeFull

type Error = Infallible

fn decode(_input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for AtomicBool

Available on target_has_atomic="8" only.

type Error = <bool as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for AtomicI8

Available on target_has_atomic="8" only.

type Error = <i8 as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for AtomicI16

Available on target_has_atomic="16" only.

type Error = <i16 as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for AtomicI32

Available on target_has_atomic="32" only.

type Error = <i32 as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for AtomicI64

Available on target_has_atomic="64" only.

type Error = <i64 as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for AtomicIsize

Available on target_has_atomic="ptr" only.

type Error = <isize as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for AtomicU8

Available on target_has_atomic="8" only.

type Error = <u8 as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for AtomicU16

Available on target_has_atomic="16" only.

type Error = <u16 as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for AtomicU32

Available on target_has_atomic="32" only.

type Error = <u32 as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for AtomicU64

Available on target_has_atomic="64" only.

type Error = <u64 as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for AtomicUsize

Available on target_has_atomic="ptr" only.

type Error = <usize as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for Duration

type Error = Infallible

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for OsString

Available on crate feature std only.

type Error = <String as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl Decode for SystemTime

Available on crate feature std only.

type Error = SystemTimeDecodeError

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<K, S> Decode for HashSet<K, S>

where K: Decode + Eq + Hash, S: BuildHasher + Default,

Available on crate feature std only.

type Error = CollectionDecodeError<Infallible, ItemDecodeError<usize, <K as Decode>::Error>>

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<K, V, S, E> Decode for HashMap<K, V, S>

where K: Decode<Error = E> + Eq + Hash, V: Decode<Error: Into<E>>, S: BuildHasher + Default,

Available on crate feature std only.

type Error = CollectionDecodeError<Infallible, ItemDecodeError<usize, E>>

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T> Decode for PhantomData<T>

type Error = Infallible

fn decode(_input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T, B> Decode for Cow<'_, B>

where T: DecodeBorrowed<B>, B: ToOwned<Owned = T> + ?Sized,

Available on crate feature alloc only.

type Error = <T as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T, E, Err> Decode for Result<T, E>

where T: Decode<Error = Err>, E: Decode<Error: Into<Err>>,

type Error = EnumDecodeError<bool, <bool as Decode>::Error, Err>

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode + Ord> Decode for BinaryHeap<T>

Available on crate feature alloc only.

type Error = <Vec<T> as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for Bound<T>

type Error = EnumDecodeError<u8, <u8 as Decode>::Error, <T as Decode>::Error>

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for Option<T>

type Error = EnumDecodeError<bool, <bool as Decode>::Error, <T as Decode>::Error>

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for (T₁, T₂, …, Tₙ)

Implemented for tuples with up to twelve members.

type Error = <T as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for Box<T>

Available on crate feature alloc only.

type Error = <T as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for LinkedList<T>

Available on crate feature alloc only.

type Error = CollectionDecodeError<Infallible, ItemDecodeError<usize, <T as Decode>::Error>>

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for Rc<T>

Available on crate feature alloc only.

type Error = <T as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for Weak<T>

Available on crate feature alloc only.

type Error = <Option<Rc<T>> as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for Arc<T>

Available on crate feature alloc and target_has_atomic="ptr" only.

type Error = <T as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for Weak<T>

Available on crate feature alloc and target_has_atomic="ptr" only.

type Error = <Option<Arc<T>> as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for Vec<T>

Available on crate feature alloc only.

type Error = CollectionDecodeError<Infallible, ItemDecodeError<usize, <T as Decode>::Error>>

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for Cell<T>

type Error = <T as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for RefCell<T>

type Error = <T as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for UnsafeCell<T>

type Error = <T as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for Saturating<T>

type Error = <T as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for Wrapping<T>

type Error = <T as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for Range<T>

type Error = <T as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for RangeFrom<T>

type Error = <T as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for RangeInclusive<T>

type Error = <T as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for RangeTo<T>

type Error = <T as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for RangeToInclusive<T>

type Error = <T as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for Mutex<T>

Available on crate feature std only.

type Error = <T as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode> Decode for RwLock<T>

Available on crate feature std only.

type Error = <T as Decode>::Error

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

impl<T: Decode, const N: usize> Decode for [T; N]

type Error = CollectionDecodeError<Infallible, ItemDecodeError<usize, <T as Decode>::Error>>

fn decode(input: &mut Input<'_>) -> Result<Self, Self::Error>

Implementors