Struct zvariant::EncodingContext[][src]

pub struct EncodingContext<B> { /* fields omitted */ }

The encoding context to use with the serialization and deserialization API.

This type is generic over the ByteOrder trait. Moreover, the encoding is dependent on the position of the encoding in the entire message and hence the need to specify the byte position of the data being serialized or deserialized. Simply pass 0 if serializing or deserializing to or from the beginning of message, or the preceeding bytes end on an 8-byte boundry.


use byteorder::LE;

use zvariant::EncodingContext as Context;
use zvariant::{from_slice, to_bytes};

let str_vec = vec!["Hello", "World"];
let ctxt = Context::<LE>::new_dbus(0);
let encoded = to_bytes(ctxt, &str_vec).unwrap();

// Let's decode the 2nd element of the array only
let ctxt = Context::<LE>::new_dbus(14);
let decoded: &str = from_slice(&encoded[14..], ctxt).unwrap();
assert_eq!(decoded, "World");


impl<B> EncodingContext<B> where
    B: ByteOrder

pub fn new(format: EncodingFormat, position: usize) -> Self[src]

Create a new encoding context.

pub fn new_dbus(position: usize) -> Self[src]

Convenient wrapper for new to create a context for D-Bus format.

pub fn new_gvariant(position: usize) -> Self[src]

Convenient wrapper for new to create a context for GVariant format.

pub fn format(self) -> EncodingFormat[src]

The EncodingFormat of this context.

pub fn position(self) -> usize[src]

The byte position of the value to be encoded or decoded, in the entire message.

Trait Implementations

impl<B: Clone> Clone for EncodingContext<B>[src]

impl<B: Copy> Copy for EncodingContext<B>[src]

impl<B: Debug> Debug for EncodingContext<B>[src]

impl<B: PartialEq> PartialEq<EncodingContext<B>> for EncodingContext<B>[src]

impl<B> StructuralPartialEq for EncodingContext<B>[src]

Auto Trait Implementations

impl<B> RefUnwindSafe for EncodingContext<B> where
    B: RefUnwindSafe

impl<B> Send for EncodingContext<B> where
    B: Send

impl<B> Sync for EncodingContext<B> where
    B: Sync

impl<B> Unpin for EncodingContext<B> where
    B: Unpin

impl<B> UnwindSafe for EncodingContext<B> where
    B: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.