Struct SailsMessageHeader 

pub struct SailsMessageHeader { /* private fields */ }

Sails message header.

The header is a feature of an IDLv2. It gives opportunity for on top of blockchain services to trace sails messages and programs.

Implementations

impl SailsMessageHeader

pub const fn new( version: Version, hlen: HeaderLength, interface_id: InterfaceId, route_id: u8, entry_id: u16, ) -> Self

Creates a new Sails message header.

pub const fn v1(interface_id: InterfaceId, entry_id: u16, route_id: u8) -> Self

pub const fn version(&self) -> Version

Gets the version of the header.

pub const fn hlen(&self) -> HeaderLength

Gets the header length.

pub const fn interface_id(&self) -> InterfaceId

Gets the interface ID.

pub const fn route_id(&self) -> u8

Gets the route ID.

pub const fn entry_id(&self) -> u16

Gets the entry ID.

impl SailsMessageHeader

pub fn to_bytes(&self) -> Vec<u8>

Serialize header to bytes.

pub fn try_read_bytes(bytes: &mut &[u8]) -> Result<Self, &'static str>

Deserialize header from bytes advancing the slice.

pub fn try_from_bytes(bytes: &[u8]) -> Result<Self, &'static str>

Deserialize header from bytes (expects magic bytes at the start) without mutating the input.

pub fn try_match_interfaces( self, interfaces: &[(InterfaceId, u8)], ) -> Result<MatchedInterface, &'static str>

Tries to match the header’s interface ID and route ID against a list of known interfaces in the program.

If the header has route_id == 0 and exactly one interface ID match exists, the returned MatchedInterface uses the program’s route_id for that interface.

Trait Implementations

impl Clone for SailsMessageHeader

fn clone(&self) -> SailsMessageHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SailsMessageHeader

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

Formats the value using the given formatter.

impl Decode for SailsMessageHeader

fn decode<I: Input>(input: &mut I) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Encode for SailsMessageHeader

fn encode_to<O: Output + ?Sized>(&self, dest: &mut O)

Convert self to a slice and append it to the destination.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl PartialEq for SailsMessageHeader

fn eq(&self, other: &SailsMessageHeader) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for SailsMessageHeader

impl StructuralPartialEq for SailsMessageHeader