Struct ArgIndex

pub struct ArgIndex(/* private fields */);

A wrapper type that represents an index into the argument section of a KSM file.

This type implements From and usize implements From, but this is provided so that it takes 1 extra step to convert raw integers into ArgIndexes which could stop potential logical bugs.

This is a kOS-governed type that is an index into the bytes of an argument section.

Implementations

impl ArgIndex

pub fn parse( source: &mut BufferIterator<'_>, index_bytes: IntSize, ) -> Result<Self, ()>

Tries to parse an ArgIndex from the byte source provided, and the NumArgIndexBytes from the argument section header.

Returns either the ArgIndex, or an Err(()), which can only happen if we ran out of bytes.

pub fn write(&self, buf: &mut Vec<u8>, index_bytes: IntSize)

Writes an ArgIndex into the provided buffer, using the NumArgIndexBytes, which is required to know how many bytes to use to write the index.

Trait Implementations

impl Clone for ArgIndex

fn clone(&self) -> ArgIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArgIndex

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

Formats the value using the given formatter.

impl From<ArgIndex> for usize

fn from(arg_idx: ArgIndex) -> Self

Converts to this type from the input type.

impl From<u16> for ArgIndex

fn from(i: u16) -> Self

Converts to this type from the input type.

impl From<u32> for ArgIndex

fn from(i: u32) -> Self

Converts to this type from the input type.

impl From<u8> for ArgIndex

fn from(i: u8) -> Self

Converts to this type from the input type.

impl From<usize> for ArgIndex

fn from(i: usize) -> Self

Converts to this type from the input type.

impl Hash for ArgIndex

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ArgIndex

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

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

const 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 Copy for ArgIndex

impl Eq for ArgIndex

impl StructuralPartialEq for ArgIndex