zvariant

Struct EncodingContext

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

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§

source§

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

source

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

Create a new encoding context.

source

pub fn new_dbus(position: usize) -> Self

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

source

pub fn format(self) -> EncodingFormat

The EncodingFormat of this context.

source

pub fn position(self) -> usize

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

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

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

source§

impl<B> StructuralPartialEq for EncodingContext<B>

Auto Trait Implementations§

§

impl<B> Freeze for EncodingContext<B>

§

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§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

source§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.