Skip to main content

EventCommandRef

Struct EventCommandRef 

Source
pub struct EventCommandRef<'a> {
    pub code: i32,
    pub indent: i32,
    pub string: &'a [u8],
    /* private fields */
}
Expand description

One event command, borrowed from the input buffer.

Fields§

§code: i32

The command code.

§indent: i32

Nesting depth inside conditional branches and loops.

§string: &'a [u8]

The command’s string operand, verbatim. Never transcoded; see the crate docs.

Implementations§

Source§

impl<'a> EventCommandRef<'a>

Source

pub const fn params(&self) -> ParamIter<'a> ⓘ

Iterate the command’s integer parameters.

Decoded on demand, not collected: most consumers read one or two parameters of the few codes they care about, and never touch the rest.

Source

pub fn param(&self, index: usize) -> Option<i32>

The parameter at index, or None if the command has fewer.

O(index): compressed integers are not fixed width, so there is no direct indexing. Fine for the small indices real code uses; iterate params for all.

Source

pub const fn param_count(&self) -> u32

How many parameters the command holds. A header declaring more than the payload has room for reports only those present (plus a DiagKind::ShortChunk), so this is always safe to size a buffer from.

Source

pub const fn raw_params(&self) -> &'a [u8] ⓘ

The undecoded parameter bytes.

For carrying the parameters somewhere before decoding them. The C API returns this span so rm2k_event_command_param can decode on demand without keeping the iterator alive.

Trait Implementations§

Source§

impl<'a> Clone for EventCommandRef<'a>

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<'a> Debug for EventCommandRef<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for EventCommandRef<'a>

§

impl<'a> RefUnwindSafe for EventCommandRef<'a>

§

impl<'a> Send for EventCommandRef<'a>

§

impl<'a> Sync for EventCommandRef<'a>

§

impl<'a> Unpin for EventCommandRef<'a>

§

impl<'a> UnsafeUnpin for EventCommandRef<'a>

§

impl<'a> UnwindSafe for EventCommandRef<'a>

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.