Skip to main content

DispatchDef

Struct DispatchDef 

Source
#[non_exhaustive]
pub struct DispatchDef { pub name: String, pub id: Scalar, pub arms: Vec<DispatchArm>, pub other: String, pub doc: Option<String>, pub derives: Vec<Derive>, pub prefix: u32, pub other_doc: Option<String>, pub other_body: Option<String>, }
Expand description

Bodies selected by an id the enclosing message has already read, as #[derive(Dispatch)] declares.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§name: String

The type name.

§id: Scalar

The id’s type: #[dispatch(id = ..)].

§arms: Vec<DispatchArm>

The arms, in declaration order.

§other: String

The fallback variant for an unlisted id.

§doc: Option<String>

Documentation.

§derives: Vec<Derive>

Derives for this catalogue, written after the module’s.

§prefix: u32

The id’s width in bits inside every payload: #[dispatch(.., prefix = K)].

Zero reads the id from elsewhere, and each payload’s Layout::PREFIX_BITS must match.

§other_doc: Option<String>

Documentation for the fallback variant. None writes a general sentence.

§other_body: Option<String>

The fallback variant’s body type. None is Vec<u8>.

Any type that is From<&[u8]> and Deref<Target = [u8]> works, such as a fixed-size type that keeps the body without allocating.

Implementations§

Source§

impl DispatchDef

Source

pub fn new(name: &str, id: Scalar, arms: Vec<DispatchArm>) -> Self

A dispatch with its fallback variant named Unknown.

Source

pub fn with_other_doc(self, doc: &str) -> Self

Sets the fallback variant’s documentation.

Source

pub fn with_prefix(self, prefix: u32) -> Self

Sets the id’s width in bits inside every payload.

Each payload declares the same width with Container::Word { prefix, .. }, and the generated code asserts that they agree.

Source

pub fn with_other_body(self, ty: &str) -> Self

Sets the fallback variant’s body type, in place of Vec<u8>.

Source

pub fn with_derives(self, derives: Vec<Derive>) -> Self

Sets the derives written on this catalogue, after the module’s.

Source

pub fn with_other(self, other: &str) -> Self

Renames the fallback variant.

Source

pub fn with_doc(self, doc: &str) -> Self

Sets the documentation.

Trait Implementations§

Source§

impl Clone for DispatchDef

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DispatchDef

Source§

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

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

impl Eq for DispatchDef

Source§

impl PartialEq for DispatchDef

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DispatchDef

Auto Trait Implementations§

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.