#[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
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.name: StringThe type name.
id: ScalarThe id’s type: #[dispatch(id = ..)].
arms: Vec<DispatchArm>The arms, in declaration order.
other: StringThe fallback variant for an unlisted id.
doc: Option<String>Documentation.
derives: Vec<Derive>Derives for this catalogue, written after the module’s.
prefix: u32The 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
impl DispatchDef
Sourcepub fn new(name: &str, id: Scalar, arms: Vec<DispatchArm>) -> Self
pub fn new(name: &str, id: Scalar, arms: Vec<DispatchArm>) -> Self
A dispatch with its fallback variant named Unknown.
Sourcepub fn with_other_doc(self, doc: &str) -> Self
pub fn with_other_doc(self, doc: &str) -> Self
Sets the fallback variant’s documentation.
Sourcepub fn with_prefix(self, prefix: u32) -> Self
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.
Sourcepub fn with_other_body(self, ty: &str) -> Self
pub fn with_other_body(self, ty: &str) -> Self
Sets the fallback variant’s body type, in place of Vec<u8>.
Sourcepub fn with_derives(self, derives: Vec<Derive>) -> Self
pub fn with_derives(self, derives: Vec<Derive>) -> Self
Sets the derives written on this catalogue, after the module’s.
Sourcepub fn with_other(self, other: &str) -> Self
pub fn with_other(self, other: &str) -> Self
Renames the fallback variant.
Trait Implementations§
Source§impl Clone for DispatchDef
impl Clone for DispatchDef
Source§fn clone(&self) -> DispatchDef
fn clone(&self) -> DispatchDef
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more