Trait Encode

Source

pub trait Encode<C> {
    // Required method
    fn encode<W: Write>(
        &self,
        e: &mut Encoder<W>,
        ctx: &mut C,
    ) -> Result<(), Error<W::Error>>;

    // Provided method
    fn is_nil(&self) -> bool { ... }
}

Expand description

A type that can be encoded to CBOR.

If this type’s CBOR encoding is meant to be decoded by Decode impls derived with minicbor_derive it is advisable to only produce a single CBOR data item. Tagging, maps or arrays can and should be used for multiple values.

Required Methods§

Source

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

Encode a value of this type using the given Encoder.

In addition to the encoder a user provided encoding context is given as another parameter. Most implementations of this trait do not need an encoding context and should be completely generic in the context type. In cases where a context is needed and the Encode impl type is meant to be combined with other types that require a different context type, it is preferrable to constrain the context type variable C with a trait bound instead of fixing the type.

Provided Methods§

Source

fn is_nil(&self) -> bool

Is this value of Self a nil value?

This method is primarily used by minicbor-derive.

Some types have a special value to denote the concept of “nothing”, aka nil. An example is the Option type with its None value. This method–if overriden–allows checking if a value is such a special nil value.

NB: A type implementing Encode with an overriden Encode::is_nil method should also override Decode::nil if it implements Decode at all.

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.

Trait Encode Copy item path

Required Methods§

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

Provided Methods§

fn is_nil(&self) -> bool

Dyn Compatibility§

Implementations on Foreign Types§

impl<C> Encode<C> for IpAddr

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for SocketAddr

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for bool

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for char

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for f32

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for f64

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for i8

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for i16

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for i32

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for i64

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for isize

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for str

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for u8

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for u16

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for u32

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for u64

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for ()

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for usize

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for CString

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for String

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for CStr

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for Ipv4Addr

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for Ipv6Addr

fn encode<W: Write>( &self, e: &mut Encoder<W>, _: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for SocketAddrV4

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for SocketAddrV6

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for AtomicBool

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for AtomicI8

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for AtomicI16

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for AtomicI32

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for AtomicI64

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for AtomicIsize

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for AtomicU8

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for AtomicU16

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for AtomicU32

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for AtomicU64

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for AtomicUsize

fn encode<W: Write>( &self, e: &mut Encoder<W>, ctx: &mut C, ) -> Result<(), Error<W::Error>>

impl<C> Encode<C> for Duration

Trait Encode

impl<C, K, V> Encode<C> for BTreeMap<K, V>
where K: Encode<C> + Eq + Ord, V: Encode<C>,

impl<C, K, V, S> Encode<C> for HashMap<K, V, S>
where K: Encode<C> + Eq + Hash, V: Encode<C>, S: BuildHasher,

impl<C, T> Encode<C> for Cow<'_, T>
where T: Encode<C> + ToOwned + ?Sized,

impl<C, T, S> Encode<C> for HashSet<T, S>
where T: Encode<C>, S: BuildHasher,