Skip to main content

ChoiceDef

Struct ChoiceDef 

Source
#[non_exhaustive]
pub struct ChoiceDef { pub name: String, pub endian: Endian, pub arms: Vec<Arm>, pub other: Option<String>, pub other_bytes: Option<usize>, pub doc: Option<String>, pub derives: Vec<Derive>, }
Expand description

The arms of a Segment::Switch.

With a fallback other variant, an unmatched value keeps its bytes: the rest of the body, or other_bytes of them.

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.

§endian: Endian

Byte order of the arms’ fields.

§arms: Vec<Arm>

The arms, in declaration order.

§other: Option<String>

The fallback variant for an unmatched value. None makes it a decode error.

§other_bytes: Option<usize>

The fallback’s size in bytes, when the choice is a union.

None takes the rest of the body, so no field can follow the switch.

§doc: Option<String>

Documentation.

§derives: Vec<Derive>

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

Implementations§

Source§

impl ChoiceDef

Source

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

A little-endian choice with no fallback.

Source

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

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

Source

pub fn with_endian(self, endian: Endian) -> Self

Sets the byte order.

Source

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

Adds a fallback variant that keeps an unmatched value’s bytes.

Source

pub fn with_other_bytes(self, bytes: usize) -> Self

Makes the choice a union of bytes bytes.

Every arm must fill exactly that size, and a field can follow the switch.

Source

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

Sets the documentation.

Source

pub fn open_ended(&self) -> bool

Whether the choice reads to the end of the body.

True when any arm does, or when the fallback has no fixed size.

Trait Implementations§

Source§

impl Clone for ChoiceDef

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 ChoiceDef

Source§

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

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

impl Eq for ChoiceDef

Source§

impl PartialEq for ChoiceDef

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 ChoiceDef

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.