Struct zvariant::EncodingContext

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

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 preceding bytes end on an 8-byte boundary.

Examples

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");

Implementations

impl<B> EncodingContext<B>

where B: ByteOrder,

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

Create a new encoding context.

pub fn new_dbus(position: usize) -> Self

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

pub fn new_gvariant(position: usize) -> Self

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

pub fn format(self) -> EncodingFormat

The EncodingFormat of this context.

pub fn position(self) -> usize

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

Trait Implementations

impl<B: Clone> Clone for EncodingContext<B>

fn clone(&self) -> EncodingContext<B>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<B: Debug> Debug for EncodingContext<B>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<B: PartialEq> PartialEq for EncodingContext<B>

fn eq(&self, other: &EncodingContext<B>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<B: Copy> Copy for EncodingContext<B>

impl<B: Eq> Eq for EncodingContext<B>

impl<B> StructuralPartialEq for EncodingContext<B>