Struct DecoderRef 

pub struct DecoderRef<'a> {
    pub abi_major: u16,
    pub abi_minor: u16,
    pub location: DecoderLocation,
    pub digest: Digest,
    pub required: CapabilitySet,
    pub name: &'a str,
}

Which decoder reads this dataset.

Fields

abi_major: u16

The ABI major version the decoder was built against.

abi_minor: u16

The ABI minor version the decoder was built against.

location: DecoderLocation

Where the module is.

digest: Digest

The digest of the module.

This is the identity of the decoder. A host that already trusts a native implementation of this exact module substitutes it here and skips the sandbox, and a host that does not runs the bytes it hashed.

required: CapabilitySet

What the decoder needs the host to be able to do.

Carrying this in the container as well as in the handshake means a host can refuse a dataset before it has loaded a single instruction of it, which is a much better error than one that arrives halfway through a query.

name: &'a str

A human readable name, for error messages.

Implementations

impl<'a> DecoderRef<'a>

pub const VERSION: u16 = 1

The record version this build writes.

pub fn encode(&self, w: &mut Writer<'_>) -> AbiResult<()>

Writes this record’s payload.

Errors

Returns whatever the writer returns.

pub fn decode(p: &mut Reader<'a>) -> AbiResult<Self>

Reads this record’s payload.

An unknown location kind decodes as DecoderLocation::External, because the one thing a reader must not do with a decoder it cannot place is run something else.

Errors

Returns iris_abi::Error if the payload is truncated or the name is not UTF-8.

Trait Implementations

impl<'a> Clone for DecoderRef<'a>

fn clone(&self) -> DecoderRef<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DecoderRef<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for DecoderRef<'a>

impl<'a> PartialEq for DecoderRef<'a>

fn eq(&self, other: &DecoderRef<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for DecoderRef<'a>